-
Notifications
You must be signed in to change notification settings - Fork 86
feature: update release cheatsheet and pipeline #1176
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?
feature: update release cheatsheet and pipeline #1176
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Signed-off-by: Anitha Natarajan <[email protected]>
25999b4 to
2024904
Compare
|
cc: @enarha |
enarha
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.
I went through the change and I have few comments. As discussed offline, we might keep this PR open until the next release where we can use the new instructions and jobs to confirm they work and only merge the PR then.
| VERSION_TAG=# UPDATE THIS. Example: v0.5.0 | ||
| RELEASE_GIT_SHA=# SHA of the release to be released | ||
| cat <<EOF > release.env | ||
| TEKTON_VERSION= # Example: v0.69.0 |
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.
this is a bit confusing, the name of the var and the example value. Isn't this about Results? I understand we want it generic, but it is just confusing. And the example version as well, given that currently Results is in version v0.17.x., we can make it v0.17.0 so similar, but not something that looks so much in the future.
| TEKTON_VERSION= # Example: v0.69.0 | ||
| TEKTON_RELEASE_GIT_SHA= # SHA of the release to be released, e.g. 5b082b1106753e093593d12152c82e1c4b0f37e5 | ||
| TEKTON_OLD_VERSION= # Example: v0.68.0 | ||
| TEKTON_RELEASE_NAME="naming pattern" # Name of the release |
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.
I think we do not have this for any other component apart from Pipeline maybe. What happens if it is not set?
| 1. Execute the Draft Release task. | ||
| 1. The YAMLs are now released! Anyone installing Tekton Results will get the new version. Time to create a new GitHub release announcement: | ||
| 1. Find the Rekor UUID for the release |
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.
Unfortunately we still do not have that for Results. We have two open issues to fix it: #442 and #525 . They are quite old, maybe it's just about time to fix that. We can keep that in the doc with some remark that the above issues have to be resolved first and we should skip the section until that happens.
| cat /workspace/.ko.yaml | ||
| - name: run-ko |
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.
I am not sure whether this step is correct or not. I think we aren't taking into account 'kustomise'.
Changes
This pull request updates the Tekton Results release process by introducing a new
publish-releaseTekton Task and updating the release documentation. The changes streamline the release workflow in line with other tektoncd components. The documentation now includes new prerequisites, environment variable conventions, improved branching guidance, and additional post-release steps.Key changes include:
1. New Tekton Task for Publishing Releases
tekton/publish.yaml, defining a comprehensivepublish-releaseTekton Task. This task automates container image publishing, registry authentication, image tagging, and release YAML generation, supporting multi-platform builds and regional registries.2. Major Improvements to Release Documentation
tekton/release-cheatsheet.mdfor clarity and completeness:rekor,kustomize), and clarified environment variable usage via arelease.envfile.tkncommands with new parameters and workspace conventions.kubectlfor the dogfooding cluster, including Oracle Cloud CLI usage.Submitter Checklist
These are the criteria that every PR should meet, please check them off as you review them:
/kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tepRelease Notes
/kind cleanup