Skip to content

Commit eebaa7e

Browse files
committed
.github: Synchronize release preparation steps
Two steps were unnecessary, remove them: - GITHUB_TOKEN setup - GOPATH setup For the vast majority of releases, release managers do not need to manually check the checkboxes of all of these steps, so convert them into a list instead. Keep the checkbox for updating the release tool as it is essential to keep this up to date. Update this section for all issue templates to ensure consistency. Signed-off-by: Joe Stringer <joe@cilium.io>
1 parent 1b4e9c8 commit eebaa7e

8 files changed

Lines changed: 76 additions & 72 deletions

.github/ISSUE_TEMPLATE/release_template_minor.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,16 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo) that has access to the repository
14-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags] with Git
15-
- [ ] Make sure the `GOPATH` environment variable is set and pointing to the relevant path
16-
- [ ] Make sure the [Cilium helm charts][Cilium charts] repository is installed locally:
17-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
21+
each automated step does.
1822

1923
## Pre-check (run ~1 week before targeted publish date)
2024

.github/ISSUE_TEMPLATE/release_template_patch.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,15 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo,project) that has access to the repository. Only classic tokens are
14-
[supported at the moment][GitHub PAT tracker], the needed scopes are `write:org`, `public_repo` and `project`.
15-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags]
16-
with Git and install [gh](https://cli.github.com).
17-
- [ ] Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
18-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
19-
- [ ] Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
20-
- [ ] If you already have the repo checked out, make sure the `release` binary is up to date:
21-
22-
git checkout main && git pull && make
23-
- [ ] Read the documentation of `release start --help` tool to understand what
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
2421
each automated step does.
2522

2623
## Pre-check (run ~1 week before release date)

.github/ISSUE_TEMPLATE/release_template_pre_main.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,15 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo,project) that has access to the repository. Only classic tokens are
14-
[supported at the moment][GitHub PAT tracker], the needed scopes are `write:org`, `public_repo` and `project`.
15-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags]
16-
with Git and install [gh](https://cli.github.com).
17-
- [ ] Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
18-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
19-
- [ ] Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
20-
- [ ] If you already have the repo checked out, make sure the `release` binary is up to date:
21-
22-
git checkout master && git pull && make
23-
- [ ] Read the documentation of `release start --help` tool to understand what
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
2421
each automated step does.
2522

2623
## Pre-check (run ~1 week before release date)

.github/ISSUE_TEMPLATE/release_template_rc_branch.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,16 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo) that has access to the repository
14-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags] with Git
15-
- [ ] Make sure the `GOPATH` environment variable is set and pointing to the relevant path
16-
- [ ] Make sure the [Cilium helm charts][Cilium charts] repository is installed locally:
17-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
21+
each automated step does.
1822

1923
## Pre-release
2024

testdata/checklist/release_template_minor.md.golden

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,16 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo) that has access to the repository
14-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags] with Git
15-
- [ ] Make sure the `GOPATH` environment variable is set and pointing to the relevant path
16-
- [ ] Make sure the [Cilium helm charts][Cilium charts] repository is installed locally:
17-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
21+
each automated step does.
1822

1923
## Pre-check (run ~1 week before targeted publish date)
2024

testdata/checklist/release_template_patch.md.golden

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,15 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo,project) that has access to the repository. Only classic tokens are
14-
[supported at the moment][GitHub PAT tracker], the needed scopes are `write:org`, `public_repo` and `project`.
15-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags]
16-
with Git and install [gh](https://cli.github.com).
17-
- [ ] Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
18-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
19-
- [ ] Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
20-
- [ ] If you already have the repo checked out, make sure the `release` binary is up to date:
21-
22-
git checkout main && git pull && make
23-
- [ ] Read the documentation of `release start --help` tool to understand what
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
2421
each automated step does.
2522

2623
## Pre-check (run ~1 week before release date)

testdata/checklist/release_template_pre_main.md.golden

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,15 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo,project) that has access to the repository. Only classic tokens are
14-
[supported at the moment][GitHub PAT tracker], the needed scopes are `write:org`, `public_repo` and `project`.
15-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags]
16-
with Git and install [gh](https://cli.github.com).
17-
- [ ] Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
18-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
19-
- [ ] Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
20-
- [ ] If you already have the repo checked out, make sure the `release` binary is up to date:
21-
22-
git checkout master && git pull && make
23-
- [ ] Read the documentation of `release start --help` tool to understand what
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
2421
each automated step does.
2522

2623
## Pre-check (run ~1 week before release date)

testdata/checklist/release_template_rc_branch.md.golden

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,16 @@ assignees: ''
99

1010
## Setup preparation
1111

12-
- [ ] Depending on your OS, make sure Docker is running
13-
- [ ] Export a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?description=Cilium%20Release%20Script&scopes=write:org,public_repo) that has access to the repository
14-
- [ ] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags] with Git
15-
- [ ] Make sure the `GOPATH` environment variable is set and pointing to the relevant path
16-
- [ ] Make sure the [Cilium helm charts][Cilium charts] repository is installed locally:
17-
- [ ] Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
12+
- Ensure Docker is installed and running
13+
- Ensure a setup is in place for [signing tags] with Git (GPG, SSH, S/MIME)
14+
- Install [gh](https://cli.github.com).
15+
- Make sure the [Cilium helm charts][Cilium charts] and [release][Cilium release-notes tool] repositories are installed locally:
16+
- Run `git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"`
17+
- Run `git clone https://github.com/cilium/release.git "$GOPATH/src/github.com/cilium/release"`
18+
- [ ] Make sure the `release` binary is up to date:
19+
`git checkout master && git pull && make`
20+
- Read the documentation of `release start --help` tool to understand what
21+
each automated step does.
1822

1923
## Pre-release
2024

0 commit comments

Comments
 (0)