Skip to content

Commit

Permalink
Update contributing.md for v2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
kccwing authored Oct 18, 2023
1 parent 3b768b3 commit e9d0572
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docs/source/content/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,19 +219,21 @@ In the release candidate branch:
5. Merge release candidate branch into `main` branch
In the `main` branch:
1. Run the [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) tool locally with the following parameters:
```
github_changelog_generator -u imperialcollegelondon -p sharpy -t <your_github_token> --future-release <new_release_version>
```
2. Push the changes to the `CHANGELOG.md` file
3. Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly
1. Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly
```
git tag -a <tagname>
git push origin --tags -f
```
where `<tagname>` is something like `2.0`.
2. Run the [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) tool locally with the following parameters:
```
github_changelog_generator -u imperialcollegelondon -p sharpy -t <your_github_token> --future-release <new_release_version>
```
3. Push the changes to the `CHANGELOG.md` file
4. Create the GitHub release, choosing the newly created tag from the dropdown menu. Do not create a tag from the dropdown menu directly because it will not be an annotated tag
5. (Optional) Merge `main` branch back into `develop` branch

0 comments on commit e9d0572

Please sign in to comment.