diff --git a/docs/new-release-procedure.md b/docs/new-release-procedure.md index 452ae9a36f..b52a6baf6c 100644 --- a/docs/new-release-procedure.md +++ b/docs/new-release-procedure.md @@ -1,8 +1,8 @@ -# New release procedure +# New Release Procedure Steps -1. **Update Release Notes.** +### Release Notes In the `rc-yyyy.x` branch, edit the release notes and do the following (firefly/docs/release-notes.md): - Start a new section for this release - Move over any notes from firefly/docs/next-release-details.md @@ -11,21 +11,22 @@ - Make sure you edit the docker tags section of this release - Update the "Pull Request for this release section", change the text and the URLs for all PR and bug fixes -2. **Ensure release passes Test** +### Ensure release passes Test - `gradle :firefly:test` -3. **Commit, Tag** - - commit your changes - _example message:_ "Release 2021.1.0: document updates" - - tag the `rc-yyyy.m` branch with the release `release-yyyy.m.r` - - _example:_ +### Commit and Tag + - Commit your changes - _example message:_ "Release 2021.1.0: document updates" + - Tag the `rc-yyyy.m` branch with the release `release-yyyy.m.r` + - _Example:_ - the second release from branch `rc-2021.2` with the git tagged with `release-2021.2.1` - `git tag release-2021.2.1` -4. **Push to GitHub**: +### Push + - Push to Github - push the rc: _example:_ `git push origin rc-2021.1` - push the tags: `git push origin --tags` -5. **Build docker images and deploy it to IRSA Kubernetes** +### Build docker images and deploy it to IRSA Kubernetes - Best to use Jenkins: https://irsawebdev5.ipac.caltech.edu:8443/view/IRSA%20k8s/job/ikc_firefly/build - Build the docker with the following docker tags: `rc-yyyy.m`, `yyyy.m`,`yyyy.m.r`, `latest` - _example:_ from the example above the release would be built with: `rc-2021.2`, `2021.2`,`2021.2.1`, `latest` @@ -37,8 +38,8 @@ - the `yyyy.m` docker tag always represents the latest release of the version - the `latest` tag is always the latest formal release. (note- development release use `nightly`) -6. **Test the release.** - - start docker on your laptop +### Test the Build + - Start docker on your laptop - `docker pull ipac/firefly:yyyy.m.r` - `docker run --rm -p 8090:8080 -m 4G --name firefly ipac/firefly:yyyy.m.r` - Look at the main page: @@ -48,7 +49,7 @@ - Look at test pages - http://localhost:8090/firefly/test -7. **Merge RC, Start a new development cycle** +### Merge RC and Start a new development cycle - merge rc into dev, use `--no-ff` to create a new commit - `git checkout dev` - `git merge --no-ff ` @@ -59,18 +60,18 @@ - For example- If you just did the 2022.1.0 release, and we are beginning work on the 2022.2 cycle: - on the dev branch - `git tag cycle-2022.2` -8. Update Docs and push + - +### Update Docs - add any improvements to this file - commit and push dev, _example message_ - "Post 2021.1 release: dev clean up" - `git push origin dev` - - push the tags: `git push origin --tags` - -9. **Edit docker hub instructions** - - Go the the Firefly page on docker hub. https://cloud.docker.com/u/ipac/repository/docker/ipac/firefly + +### Update Docker Hub instructions + - Go to the Firefly page on docker hub. https://cloud.docker.com/u/ipac/repository/docker/ipac/firefly - Edit the markdown to include the recent tags -10. **Publish a new release on Github.** - - The text should use the [release-page-template.md](release-page-template.md) - - After using the template, copy the markdown (for this release only) from the release-notes.md +### Publish on Github + - The text should use the [release-page-template.md](release-page-template.md) + - After using the template, copy the markdown (for this release only) from the release-notes.md - paste markdown at the end of the template diff --git a/docs/release-notes.md b/docs/release-notes.md index a5ab06c66d..289271a9e9 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -8,8 +8,10 @@ ## Version 2021.4 (December 2021) +- 2021.4.1 (Feb 2022) + - docker tag: `latest`, `release-2021.4`, `release-2021.4.1` - 2021.4 (December 2021) - - docker tag: `latest`, `release-2021.4`, `release-2021.4.0` + - docker tag: `release-2021.4.0` ### _Notes_ #### New features - This release contains some significant new features and UI improvements @@ -46,6 +48,10 @@ - [Bug Fixes](https://github.com/caltech-ipac/firefly/pulls?q=is%3apr+milestone%3a2021.4+label%3abug) - [All PRs](https://github.com/caltech-ipac/firefly/pulls?q=is%3apr++milestone%3a2021.4+) +##### _Patches 2021.4_ +- 2021.4.1 + - IBE not passing credentials ([Firefly-938](https://github.com/Caltech-IPAC/firefly/pull/1189)) + - Better version tracking ([Firefly-915](https://github.com/Caltech-IPAC/firefly/pull/1165)) ## Version 2021.3 (August 2021)