-
Notifications
You must be signed in to change notification settings - Fork 581
feature: automate helm version update process #1767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
scottrigby
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!
Today after releasing 3.19.0 and updating the docs with a combination of scripts and manual steps, i thought again that the entire release process (see Helm Release Checklist) could be more automated.
The release checklist itself could also use an update — there are things we just don't document checking, for example updating the version skew in other languages.
For this PR, i have some thoughts.
Split the functionality:
- I'm thinking there should be two scripts: one to poll for newer Helm versions, and another to update the docs in all the places we need for a new version
- the first can be on a cron, and can trigger the second passing the version as an arg to workflow_dispatch (and once we have full helm 4 releases, the same workflow can be triggered for each new Helm 3 and Helm 4 version)
- when the workflow_dispatch is manually triggered, the user can pass the version as the argument
☝️ what do you think about this?
More simplifications:
- no need to check for Helm 2 updates - there are no more
- we can remove docker call from the script - the workflow will run on ubuntu already (users who want to run manually can run the script from within a container if they wish)
- the readme for this script may be too verbose, especially given the details may change with the new docs site. I think it would be better for the make targets and script in general to be mostly self-documenting, with perhaps a mention in the main README.
Other details:
- all files need a newline at EOF
- the make target name should probably be
update-docs-versionor something more specific thanupdate-docs(we are in fact only updating the version)
|
I agree that "no need to check for Helm 2 updates - there are no more", but that can stand as a placeholder for v4 when that become available. I don't want to remove the capability to update two releases. |
|
Notes in italic about what is done and what is not or partial: Split the functionality:
More simplifications:
Other details:
|
6273138 to
cdd039c
Compare
2b6af46 to
b4c2168
Compare
|
Updated for new site. Seems to work. |
Signed-off-by: Terry Howe <[email protected]>
b4c2168 to
98d0400
Compare
Add an automated periodic update job that checks for new Helm releases and updates the documentation accordingly.
Example output: #1953
How it works
The update job runs daily at 2am Pacific (9am UTC) and performs the following steps:
config.tomlfor new minor releases of v3 and v2sdkexamples/go.modfor v3 updates