From 732978e4100bfd3bd418bbd3f56469adc1587732 Mon Sep 17 00:00:00 2001 From: David Grove Date: Wed, 2 Oct 2024 13:35:45 -0400 Subject: [PATCH] release instructions for helm chart; update release-chart action --- .github/workflows/release-chart.yaml | 9 +++++---- .../release-instructions.md | 20 +++++++++++++++++++ 2 files changed, 25 insertions(+), 4 deletions(-) create mode 100644 tools/pytorchjob-generator/release-instructions.md diff --git a/.github/workflows/release-chart.yaml b/.github/workflows/release-chart.yaml index 4ecf435..8a6cff5 100644 --- a/.github/workflows/release-chart.yaml +++ b/.github/workflows/release-chart.yaml @@ -1,10 +1,8 @@ name: Release Charts on: - push: - # Sequence of patterns matched against refs/tags - tags: - - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 + # This workflow is meant to be triggered manually from the Actions tab + workflow_dispatch: jobs: release: @@ -33,3 +31,6 @@ jobs: skip_existing: true env: CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" + + - name: Publish to GH Pages + uses: ./.github/workflows/gh-pages-static.yml diff --git a/tools/pytorchjob-generator/release-instructions.md b/tools/pytorchjob-generator/release-instructions.md new file mode 100644 index 0000000..fb2a0ea --- /dev/null +++ b/tools/pytorchjob-generator/release-instructions.md @@ -0,0 +1,20 @@ +## Release Instructions + +1. Create a release prep branch + +2. Update the version number in chart/Chart.yaml + +3. Do a `helm unittest -u chart` and then run precommit to + regenerate the helmdocs. Inspect the diff and make sure + the only changes are the Chart version + +4. Update the chart version number in the example + of `helm repo search` in the main README.md + +5. Submit & merge a PR with these changes + +6. Manually trigger the `Release Charts` workflow in the Actions + tab of the MLBatch GitHub project. This action will automatically + generate and push tags for the newly released chart and trigger an + update of the GH Pages (which contains the helm repo). +