Skip to content

Commit

Permalink
Added announcement bar update step to making a release doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ajstewart committed Apr 23, 2021
1 parent 7298585 commit 0e60dd8
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/developing/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ In to order to make a release, please follow these steps (example: making the `0

1. Make sure that every new feature and PR will be merged to master, before continuing with the releasing process.
2. Update the [`CHANGELOG.md`](https://github.com/askap-vast/vast-pipeline/blob/master/CHANGELOG.md){:target="_blank"} on `master` directly (only admin can and need to force-push the changes) with the list of changes. An example of format can be found [here](https://github.com/apache/incubator-superset/blob/master/CHANGELOG.md){:target="_blank"}.
3. The `0.2.X` branch will be updated by merging `master` into `0.2.X`.
4. Branch off `0.2.X` and call it `0.2.1`, then change the `package.json` with the version of the release, commit and tag the commit. Push commit and tag to origin.
5. Make a release in GitHub using that tag.
3. Update the "announcement bar" in the documentation to refer to the new release. This can be found in `docs/custom_home/main.html` at line 37.
4. The `0.2.X` branch will be updated by merging `master` into `0.2.X`.
5. Branch off `0.2.X` and call it `0.2.1`, then change the `package.json` with the version of the release, commit and tag the commit. Push commit and tag to origin.
6. Make a release in GitHub using that tag.

__NOTE__: keep the version on `master` branch to something like 99.99.99dev and in `0.2.X` branch to something like 0.2.99dev. In the release branch, change only the version in [`package.json`](https://github.com/askap-vast/vast-pipeline/blob/master/package.json){:target="_blank"}.

0 comments on commit 0e60dd8

Please sign in to comment.