|
| 1 | +# Release Process |
| 2 | + |
| 3 | +The NVIDIA Container Toolkit consists of the following artifacts: |
| 4 | +- The NVIDIA Container Toolkit container |
| 5 | +- Packages for debian-based systems |
| 6 | +- Packages for rpm-based systems |
| 7 | + |
| 8 | +# Release Process Checklist: |
| 9 | +- [ ] Create a release PR: |
| 10 | + - [ ] Run the `./hack/prepare-release.sh` script to update the version in all the needed files. This also creates a [release issue](https://github.com/NVIDIA/cloud-native-team/issues?q=is%3Aissue+is%3Aopen+label%3Arelease) |
| 11 | + - [ ] Run the `./hack/generate-changelog.sh` script to generate the a draft changelog and update `CHANGELOG.md` with the changes. |
| 12 | + - [ ] Create a PR from the created `bump-release-{{ .VERSION }}` branch. |
| 13 | +- [ ] Merge the release PR |
| 14 | +- [ ] Tag the release and push the tag to the `internal` mirror: |
| 15 | + - [ ] Image release pipeline: https://gitlab-master.nvidia.com/dl/container-dev/container-toolkit/-/pipelines/16466098 |
| 16 | +- [ ] Wait for the image release to complete. |
| 17 | +- [ ] Push the tag to the the upstream GitHub repo. |
| 18 | +- [ ] Wait for the [`Release`](https://github.com/NVIDIA/k8s-device-plugin/actions/workflows/release.yaml) GitHub Action to complete |
| 19 | +- [ ] Publish the [draft release](https://github.com/NVIDIA/k8s-device-plugin/releases) created by the GitHub Action |
| 20 | +- [ ] Publish the packages to the gh-pages branch of the libnvidia-container repo |
| 21 | +- [ ] Create a KitPick |
| 22 | + |
| 23 | +## Troubleshooting |
| 24 | + |
| 25 | +*Note*: This assumes that we have the release tag checked out locally. |
| 26 | + |
| 27 | +- If the `Release` GitHub Action fails: |
| 28 | + - Check the logs for the error first. |
| 29 | + - Create the helm packages locally by running: |
| 30 | + ```bash |
| 31 | + ./hack/prepare-artifacts.sh {{ .VERSION }} |
| 32 | + ``` |
| 33 | + - Create the draft release by running: |
| 34 | + ```bash |
| 35 | + ./hack/create-release.sh {{ .VERSION }} |
| 36 | + ``` |
0 commit comments