Skip to content

Commit abf97a6

Browse files
authored
release instructions for helm chart; update release-chart action (#75)
1 parent 2b56a4b commit abf97a6

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

.github/workflows/release-chart.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
name: Release Charts
22

33
on:
4-
push:
5-
# Sequence of patterns matched against refs/tags
6-
tags:
7-
- 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
4+
# This workflow is meant to be triggered manually from the Actions tab
5+
workflow_dispatch:
86

97
jobs:
108
release:
@@ -33,3 +31,6 @@ jobs:
3331
skip_existing: true
3432
env:
3533
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
34+
35+
- name: Publish to GH Pages
36+
uses: ./.github/workflows/gh-pages-static.yml
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Release Instructions
2+
3+
1. Create a release prep branch
4+
5+
2. Update the version number in chart/Chart.yaml
6+
7+
3. Do a `helm unittest -u chart` and then run precommit to
8+
regenerate the helmdocs. Inspect the diff and make sure
9+
the only changes are the Chart version
10+
11+
4. Update the chart version number in the example
12+
of `helm repo search` in the main README.md
13+
14+
5. Submit & merge a PR with these changes
15+
16+
6. Manually trigger the `Release Charts` workflow in the Actions
17+
tab of the MLBatch GitHub project. This action will automatically
18+
generate and push tags for the newly released chart and trigger an
19+
update of the GH Pages (which contains the helm repo).
20+

0 commit comments

Comments
 (0)