Skip to content
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

Update documentation for registry-operator release process #1421

Open
5 tasks
Jdubrick opened this issue Jan 22, 2024 · 2 comments
Open
5 tasks

Update documentation for registry-operator release process #1421

Jdubrick opened this issue Jan 22, 2024 · 2 comments
Labels
area/documentation Improvements or additions to documentation area/registry Devfile registry for stacks and infrastructure lifecycle/stale Stale items. These items have not been updated for 90 days. status/blocked

Comments

@Jdubrick
Copy link
Contributor

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.

@Jdubrick
Copy link
Contributor Author

Adding blocked label as this should wait until final completion of devfile/registry-operator#75

@openshift-ci openshift-ci bot added area/registry Devfile registry for stacks and infrastructure area/documentation Improvements or additions to documentation labels Jan 22, 2024
Copy link

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/registry Devfile registry for stacks and infrastructure lifecycle/stale Stale items. These items have not been updated for 90 days. status/blocked
Projects
Status: Refinement
Development

No branches or pull requests

1 participant