Skip to content

Commit 29f4a8b

Browse files
committed
backup
1 parent da2a622 commit 29f4a8b

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

RELEASING.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,17 @@ neatly document any changes that may happen during QA, such as bug fixes, and se
88
### Overview
99

1010
The robot release process has 3 main outputs:
11-
- Electron app
11+
12+
- Opentrons App
1213
- OT-2 system package
1314
- Flex system package
1415

16+
The robot software stack is composed of the following repositories:
17+
- [oe_core]("https://github.com/Opentrons/oe-core")
18+
- [ot3_firmware]("https://github.com/Opentrons/ot3-firmware")
19+
- [opentrons]("https://github.com/Opentrons/opentrons")
20+
- [opentrons_modules]("https://github.com/Opentrons/opentrons-modules")
21+
- [buildroot]("https://github.com/Opentrons/buildroot")
1522

1623
```mermaid
1724
flowchart LR
@@ -39,19 +46,13 @@ flowchart LR
3946
opentrons --> FlexBuild
4047
oe_core --> FlexBuild
4148
ot3_firmware --> FlexBuild
42-
43-
click oe_core "https://github.com/Opentrons/oe-core" _blank
44-
click ot3_firmware "https://github.com/Opentrons/ot3-firmware" _blank
45-
click opentrons "https://github.com/Opentrons/opentrons" _blank
46-
click opentrons_modules "https://github.com/Opentrons/opentrons-modules" _blank
47-
click buildroot "https://github.com/Opentrons/buildroot" _blank
4849
```
4950

50-
These are all versioned and released together. These assets are produced in 2 possible channels:
51+
These are all versioned and released together. These assets are produced in 2 possible channels:
52+
5153
- Release (External facing releases - stable, beta, alpha)
5254
- Internal Release (Internal facing releases - stable, beta, alpha)
5355

54-
5556
### Steps to release
5657

5758
1. Checkout `edge` and make a chore release branch, without any new changes. The branch name should match `chore_release-*`.
@@ -79,17 +80,17 @@ only use annotated tags
7980
git tag -a v${alphaVersion} -m 'chore(release): ${alphaVersion}'
8081
```
8182

82-
5. Review the tag with `git show v${alphaVersion}`. Double check that the commit displayed is the one you want - it should probably be the latest commit in your release branch, and you should double check that with the Github web UI. If the tag looks good, push it - this starts the build process. This is a release candidate that will undergo QA.
83+
4. Review the tag with `git show v${alphaVersion}`. Double check that the commit displayed is the one you want - it should probably be the latest commit in your release branch, and you should double check that with the Github web UI. If the tag looks good, push it - this starts the build process. This is a release candidate that will undergo QA.
8384

8485
```shell
8586
git push origin v${alphaVersion}
8687
```
8788

8889
Changelogs for the release are automatically generated when the tag is pushed and sent to the release page in github.
8990

90-
6. Run QA on this release. If issues are found, create PRs targeted on the release branch. To create new alpha releases, repeat steps 4-6.
91+
5. Run QA on this release. If issues are found, create PRs targeted on the release branch. To create new alpha releases, repeat steps 4-6.
9192

92-
7. Once QA is a pass, do a final check that the release notes are good and wordsmithed, and then do a NORMAL MERGE into `release`. Do NOT squash or rebase; do NOT yet push a tag. This should be done from your local command line (and will succeed as long as the release PR is reviewed and status checks have passed):
93+
6. Once QA is a pass, do a final check that the release notes are good and wordsmithed, and then do a NORMAL MERGE into `release`. Do NOT squash or rebase; do NOT yet push a tag. This should be done from your local command line (and will succeed as long as the release PR is reviewed and status checks have passed):
9394

9495
```shell
9596
# note: make sure you have pulled the latest changes for branch
@@ -103,7 +104,7 @@ only use annotated tags
103104
git push origin release
104105
```
105106

106-
8. Make a tag for the release. This tag will have the actual target release version, no alpha prerelease tags involved. It should be the same as the `${version}` part of your release branch:
107+
7. Make a tag for the release. This tag will have the actual target release version, no alpha prerelease tags involved. It should be the same as the `${version}` part of your release branch:
107108

108109
```shell
109110
git tag -a v${version} -m 'chore(release): ${version}'
@@ -120,24 +121,24 @@ only use annotated tags
120121

121122
The tag push will kick off release builds and deploy the results to customers. It will also create a release page where those builds and automatically generated in-depth changelogs will be posted.
122123

123-
9. Ensure all deploy jobs succeeded:
124+
8. Ensure all deploy jobs succeeded:
124125

125126
- The Opentrons App should be prompting people to update to the new version.
126127
- https://pypi.org/project/opentrons/ should be showing the new version.
127128

128-
10. Release the Python Protocol API docs for this version (see below under Releasing Web Projects).
129+
9. Release the Python Protocol API docs for this version (see below under Releasing Web Projects).
129130

130-
11. Update the download links on https://opentrons.com/ot-app/. That page is defined in an Opentrons private repository.
131+
10. Update the download links on https://opentrons.com/ot-app/. That page is defined in an Opentrons private repository.
131132

132-
12. Open a PR of `release` into `edge`. Give the PR a name like `chore(release): Merge changes from ${version} into edge`. Once it passes, on the command line merge it into `edge`:
133+
11. Open a PR of `release` into `edge`. Give the PR a name like `chore(release): Merge changes from ${version} into edge`. Once it passes, on the command line merge it into `edge`:
133134

134135
```shell
135136
git checkout edge
136137
git pull
137138
git merge --no-ff release
138139
```
139140

140-
13. Use the PR title for the merge commit title. You can then `git push origin edge`, which will succeed as long as the PR is approved and status checks pass.
141+
12. Use the PR title for the merge commit title. You can then `git push origin edge`, which will succeed as long as the PR is approved and status checks pass.
141142

142143
## Releasing Robot Software Stack Hotfixes
143144

0 commit comments

Comments
 (0)