Skip to content

Commit 053de26

Browse files
committed
release-2021.4.1: document updates
1 parent 84535f7 commit 053de26

File tree

2 files changed

+28
-21
lines changed

2 files changed

+28
-21
lines changed

docs/new-release-procedure.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

2-
# New release procedure
2+
# New Release Procedure Steps
33

44

5-
1. **Update Release Notes.**
5+
### Release Notes
66
In the `rc-yyyy.x` branch, edit the release notes and do the following (firefly/docs/release-notes.md):
77
- Start a new section for this release
88
- Move over any notes from firefly/docs/next-release-details.md
@@ -11,21 +11,22 @@
1111
- Make sure you edit the docker tags section of this release
1212
- Update the "Pull Request for this release section", change the text and the URLs for all PR and bug fixes
1313

14-
2. **Ensure release passes Test**
14+
### Ensure release passes Test
1515
- `gradle :firefly:test`
1616

17-
3. **Commit, Tag**
18-
- commit your changes - _example message:_ "Release 2021.1.0: document updates"
19-
- tag the `rc-yyyy.m` branch with the release `release-yyyy.m.r`
20-
- _example:_
17+
### Commit and Tag
18+
- Commit your changes - _example message:_ "Release 2021.1.0: document updates"
19+
- Tag the `rc-yyyy.m` branch with the release `release-yyyy.m.r`
20+
- _Example:_
2121
- the second release from branch `rc-2021.2` with the git tagged with `release-2021.2.1`
2222
- `git tag release-2021.2.1`
2323

24-
4. **Push to GitHub**:
24+
### Push
25+
- Push to Github
2526
- push the rc: _example:_ `git push origin rc-2021.1`
2627
- push the tags: `git push origin --tags`
2728

28-
5. **Build docker images and deploy it to IRSA Kubernetes**
29+
### Build docker images and deploy it to IRSA Kubernetes
2930
- Best to use Jenkins: https://irsawebdev5.ipac.caltech.edu:8443/view/IRSA%20k8s/job/ikc_firefly/build
3031
- Build the docker with the following docker tags: `rc-yyyy.m`, `yyyy.m`,`yyyy.m.r`, `latest`
3132
- _example:_ from the example above the release would be built with: `rc-2021.2`, `2021.2`,`2021.2.1`, `latest`
@@ -37,8 +38,8 @@
3738
- the `yyyy.m` docker tag always represents the latest release of the version
3839
- the `latest` tag is always the latest formal release. (note- development release use `nightly`)
3940

40-
6. **Test the release.**
41-
- start docker on your laptop
41+
### Test the Build
42+
- Start docker on your laptop
4243
- `docker pull ipac/firefly:yyyy.m.r`
4344
- `docker run --rm -p 8090:8080 -m 4G --name firefly ipac/firefly:yyyy.m.r`
4445
- Look at the main page:
@@ -48,7 +49,7 @@
4849
- Look at test pages
4950
- http://localhost:8090/firefly/test
5051

51-
7. **Merge RC, Start a new development cycle**
52+
### Merge RC and Start a new development cycle
5253
- merge rc into dev, use `--no-ff` to create a new commit
5354
- `git checkout dev`
5455
- `git merge --no-ff <rc-branch>`
@@ -59,18 +60,18 @@
5960
- For example- If you just did the 2022.1.0 release, and we are beginning work on the 2022.2 cycle:
6061
- on the dev branch
6162
- `git tag cycle-2022.2`
62-
8. Update Docs and push
63+
-
64+
### Update Docs
6365
- add any improvements to this file
6466
- commit and push dev, _example message_ - "Post 2021.1 release: dev clean up"
6567
- `git push origin dev`
66-
- push the tags: `git push origin --tags`
67-
68-
9. **Edit docker hub instructions**
69-
- Go the the Firefly page on docker hub. https://cloud.docker.com/u/ipac/repository/docker/ipac/firefly
68+
69+
### Update Docker Hub instructions
70+
- Go to the Firefly page on docker hub. https://cloud.docker.com/u/ipac/repository/docker/ipac/firefly
7071
- Edit the markdown to include the recent tags
7172

72-
10. **Publish a new release on Github.**
73-
- The text should use the [release-page-template.md](release-page-template.md)
74-
- After using the template, copy the markdown (for this release only) from the release-notes.md
73+
### Publish on Github
74+
- The text should use the [release-page-template.md](release-page-template.md)
75+
- After using the template, copy the markdown (for this release only) from the release-notes.md
7576
- paste markdown at the end of the template
7677

docs/release-notes.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88

99

1010
## Version 2021.4 (December 2021)
11+
- 2021.4.1 (Feb 2022)
12+
- docker tag: `latest`, `release-2021.4`, `release-2021.4.1`
1113
- 2021.4 (December 2021)
12-
- docker tag: `latest`, `release-2021.4`, `release-2021.4.0`
14+
- docker tag: `release-2021.4.0`
1315

1416
### _Notes_
1517
#### New features - This release contains some significant new features and UI improvements
@@ -46,6 +48,10 @@
4648
- [Bug Fixes](https://github.com/caltech-ipac/firefly/pulls?q=is%3apr+milestone%3a2021.4+label%3abug)
4749
- [All PRs](https://github.com/caltech-ipac/firefly/pulls?q=is%3apr++milestone%3a2021.4+)
4850

51+
##### _Patches 2021.4_
52+
- 2021.4.1
53+
- IBE not passing credentials ([Firefly-938](https://github.com/Caltech-IPAC/firefly/pull/1189))
54+
- Better version tracking ([Firefly-915](https://github.com/Caltech-IPAC/firefly/pull/1165))
4955

5056

5157
## Version 2021.3 (August 2021)

0 commit comments

Comments
 (0)