-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9110 from nawazkh/create_provider_issues
✨ add utility to create git issues on provider repo
- Loading branch information
Showing
4 changed files
with
398 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Update CAPI Providers with CAPI beta releases | ||
|
||
`provider_issues` is a go utility intended to open git issues on provider repos about the first beta minor release of CAPI. | ||
|
||
## Pre-requisites | ||
|
||
- Create a github token with the below access and export it in your environment as `GITHUB_ISSUE_OPENER_TOKEN`. Set the validity to the least number of days since this utility is a one time use tool per release cycle. | ||
- `repo:status` - Grants access to commit status on public and private repositories. | ||
- `repo_deployment` - Grants access to deployment statuses on public and private repositories. | ||
- `public_repo` - Grants access to public repositories | ||
|
||
- Export `PROVIDER_ISSUES_DRY_RUN` environment variable to `"true"` to run the utility in dry run mode. Export it to `"false"` to create issues on the provider repositories. Example: | ||
|
||
```sh | ||
export PROVIDER_ISSUES_DRY_RUN="true" | ||
``` | ||
|
||
- Export `RELEASE_TAG` environment variable to the CAPI release version e.g. `1.6.0`. The suffix `-beta.0` is appended by the utility. | ||
Example: | ||
|
||
```sh | ||
export RELEASE_TAG="1.6.0" | ||
``` | ||
|
||
- Export `RELEASE_DATE` to the targeted CAPI release version date. Fetch the target date from latest [release file](https://github.com/kubernetes-sigs/cluster-api/tree/main/docs/release/releases). | ||
Example: | ||
|
||
```sh | ||
export RELEASE_DATE="2023-11-28" | ||
``` | ||
|
||
## How to run the tool | ||
|
||
- Finish the pre-requites [tasks](#pre-requisites). | ||
- From the root of the project Cluster API, run `make release-provider-issues-tool` to create issues at provider repositories. | ||
- Note that the utility will | ||
- do a dry run on setting `PROVIDER_ISSUES_DRY_RUN="true"` (and will not create git issues) | ||
- create git issues on setting `PROVIDER_ISSUES_DRY_RUN="false"`. |
Oops, something went wrong.