Add release process documentation; change container RFC to published#74
Conversation
| ## Primer | ||
|
|
||
| This document is based on the process set forth by the [DataWorkflowServices Release | ||
| Process](https://dataworkflowservices.github.io/v0.0.1/repo-guides/create-a-release/readme/#github-release-process). |
There was a problem hiding this comment.
Drop the #github-release-process from this.
|
|
||
| ## Release Each Component In `nnf-deploy` | ||
|
|
||
| As mentioned above, you'll first need to create releases for each component contained in |
There was a problem hiding this comment.
Drop the "As mentioned above". Omit needless words.
|
|
||
| Each release branch needs to be updated with what is on master. To do that, we'll need the latest | ||
| copy of master, and it will ultimately be merged to the `releases/v0` branch via a Pull Request. | ||
| Once merged, a tag is created and then a release. |
There was a problem hiding this comment.
"a tag" => "an annotated tag"
| end. | ||
|
|
||
| 5. For `lustre-csi-driver` and `lustre-fs-operator`, there are additional files that need to track | ||
| the version number as well. |
There was a problem hiding this comment.
We should explain the reason for this:
"as well." => "as well, which allow them to be installed with kubectl apply -k."
| git checkout master | ||
| git pull | ||
| git checkout -b update-submodules | ||
| git submodule foreach git checkout master |
There was a problem hiding this comment.
You should be able to use the ./update.sh script here.
| other components. | ||
|
|
||
| - [NearNodeFlash/nnf-deploy](https://github.com/NearNodeFlash/nnf-deploy) | ||
| * [NearNodeFlash/nnf-dm](https://github.com/NearNodeFlash/nnf-dm) |
There was a problem hiding this comment.
nnf-dm requires nnf-sos, so have it follow sos.
| * [NearNodeFlash/nnf-dm](https://github.com/NearNodeFlash/nnf-dm) | ||
| * [NearNodeFlash/nnf-mfu](https://github.com/NearNodeFlash/nnf-mfu) | ||
| * [NearNodeFlash/nnf-sos](https://github.com/NearNodeFlash/nnf-sos) | ||
| * [HewlettPackard/dws](https://github.com/HewlettPackard/dws) |
There was a problem hiding this comment.
dws is required by nearly everything else, so move it to the top.
| * [NearNodeFlash/nnf-sos](https://github.com/NearNodeFlash/nnf-sos) | ||
| * [HewlettPackard/dws](https://github.com/HewlettPackard/dws) | ||
| * [HewlettPackard/lustre-csi-driver](https://github.com/HewlettPackard/lustre-csi-driver) | ||
| * [NearNodeFlash/lustre-fs-operator](https://github.com/NearNodeFlash/lustre-fs-operator) |
There was a problem hiding this comment.
lustre-fs-operator is required by nnf-sos and nnf-dm, so move it before them.
|
|
||
| <details> | ||
| <summary>Component Version Numbers</summary> | ||
| Each component has its own version number that needs to be incremented. Make sure you change the |
There was a problem hiding this comment.
I think this paragraph should not hide.
The v0.0.3 below does not make sense if this paragraph is not expanded, so it doesn't really qualify as a side-note.
| `charts/lustre-csi-driver/values.yaml` with the correct version. | ||
|
|
||
| 6. Create a Pull Request from your branch and **target the release branch**. When merging the Pull | ||
| Request, **you must use a Merge Commit. Do not Rebase or Squash.** |
There was a problem hiding this comment.
We should explain the reason for this:
| Request, **you must use a Merge Commit. Do not Rebase or Squash.** | |
| !!! note | |
| Do not Rebase or Squash! Those actions will remove the records that Git | |
| uses to determine which commits have been merged, and then when the next | |
| release is created Git will treat everything like a conflict. | |
There was a problem hiding this comment.
VSCode will render that !!! note line literally. That's okay, because 'mike' will render it as a "note" with a little pencil icon next to it. See it how a !!! note looks here: https://nearnodeflash.github.io/v0.0.2/guides/user-containers/readme/
| a. For `lustre-fs-operator`, update `config/manager/kustomization.yaml` with the correct | ||
| version. | ||
|
|
||
| . For `lustre-csi-driver`, update `deploy/kubernetes/base/kustomization.yaml` and |
There was a problem hiding this comment.
You lost the 'b' here.
|
This is awesome. Thanks for doing this. |
3 participants
No description provided.