Closed as not planned
Description
Which area/kind this issue is related to?
/area registry
/area documentation
Issue Description
After completion of #1326 we will need to update the registry-operator
release documentation to include usage instructions. The document outlining the current process that needs to be updated can be found here.
The following changes should be made to the documentation after the completion of #1326 as it is currently waiting on changes to the prior release.
Acceptance Criteria
The release process changes will be made here.
- Add instructions for ensuring yq is installed
- Add instructions for exporting
GITHUB_TOKEN
(see below) - Add instructions for running the script with
make release NEW_VERSION=x.x.x
(see README) - Add instructions for filling out the PR description as the automation cannot write a description. You will need to outline where to find the template and how to fill out the template for a release.
- Add instructions telling those who are performing the release to avoid using
squash
functionalities, the entire git history is necessary for the script to run properly.
GITHUB_TOKEN
This script requires the export of an environment variable named GITHUB_TOKEN
. This token is a PAT created from your GitHub account here. The token will require repo
access.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Done ✅