Skip to content

Commit 3160aaa

Browse files
authored
Update release procedure (#605)
* update release procedure * add links to synapse
1 parent f607e3a commit 3160aaa

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -141,21 +141,30 @@ patch.object(MODULE_NAME, "FUNCTION_TO_MOCK_NAME".return_value=SOME_RETURN_VALUE
141141
Follow gitflow best practices as linked above.
142142

143143
1. Always merge all new features into `develop` branch first (unless it is a documentation, readme, or github action patch into `main`)
144-
2. After initial features are ready in the `develop` branch, create a `release-X.X` branch (**do not** push this branch to remote) to prepare for the release.
145-
1. update the `__version__` parameter in `genie/__init__.py`
146-
3. Merge `release-X.X.X` branch into `main` - Not by pull request! Resolve any merge conflicts.
147-
4. Create release tag (`v...`) and a brief message
148-
149-
```bash
150-
git tag -a v<X.X.X> -m "Release <X.X.X>"
151-
```
152-
153-
5. Prior to pushing changes into `main`, reset any annotations on the test project/rename maf database table as integration tests will run.
154-
6. Push tag and change(s) from `main`.
155-
7. Create a new release on the repo. Include release notes. See [writing release notes for project](https://sagebionetworks.jira.com/wiki/spaces/DPE/pages/3892543489/Writing+release+notes+for+projects) for creating informative technical release notes. See [example release](https://github.com/Sage-Bionetworks/Genie/releases/tag/v16.5.0) for typical sections to include in a Genie release. Also include any known bugs for each release here. Wait for the CI/CD to finish.
156-
8. Merge `main` back into `develop`
157-
9. Prior to pushing changes into `develop`, reset any annotations on the test project/rename maf database table as integration tests will run.
158-
10. Push changes in `develop`. Wait for the CI/CD to finish
144+
2. After initial features are ready in the `develop` branch, create a `release-X.X.X` branch (**do not** push this branch to remote) to prepare for the release.
145+
3. Update the `__version__` parameter in `genie/__init__.py`. Create a commit with a message like `"Release <X.X.X>"`
146+
4. Merge `release-X.X.X` branch into `main` - Not by pull request! Resolve any merge conflicts.
147+
5. Prior to pushing changes into `main`, reset any [annotations on the test project](https://www.synapse.org/Synapse:syn11601248/tables/)/[rename maf database table](https://www.synapse.org/Synapse:syn7208886/tables/) as integration tests will run.
148+
6. Push change(s) from `main`.
149+
7. You can do the following either through git or through the Github UI
150+
1. Create release tag (`v...`) and a brief message
151+
152+
```bash
153+
git tag -a v<X.X.X> -m "Release <X.X.X>"
154+
```
155+
2. Push tag from `main` to remote.
156+
157+
OR
158+
159+
1. Create your tag via the release notes UI on github by creating the tag name `vX.X.X`. **Be sure to set `target branch` as `main`!**
160+
8. Create a new release on the repo (if you created your tag through git prior, select your tag here). Include release notes. See [writing release notes for project](https://sagebionetworks.jira.com/wiki/spaces/DPE/pages/3892543489/Writing+release+notes+for+projects) for creating informative technical release notes.
161+
- See [example release](https://github.com/Sage-Bionetworks/Genie/releases/tag/v16.5.0) for typical sections to include in a Genie release.
162+
- You will also have to add a `Highlights` section and summarize it as you see git.
163+
9. Wait for the CI/CD to finish. You should see a new pypi release here: https://pypi.org/project/aacrgenie/.
164+
10. Merge `main` back into `develop`.
165+
11. Prior to pushing changes into `develop`, reset any [annotations on the test project](https://www.synapse.org/Synapse:syn11601248/tables/)/[rename maf database table](https://www.synapse.org/Synapse:syn7208886/tables/) as integration tests will run.
166+
12. Push changes in `develop`.
167+
13. Wait for the CI/CD to finish.
159168

160169
### Modifying Docker
161170

0 commit comments

Comments
 (0)