Skip to content

Commit f9b42d1

Browse files
authored
misc: update release checklist (#458)
Updated the release checklist to spread out important steps into their own checkboxes.
1 parent f148e51 commit f9b42d1

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,21 @@ labels: release
1111
After completing each task put an `x` in the corresponding box,
1212
and paste the link to the relevant PR.
1313
-->
14-
- [ ] Make sure all examples and docs reference the new provider version.
15-
- [ ] Make sure the [VERSION](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/VERSION) and [internal/provider/version.go](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/oxide/version.go) files have the new version you want to release.
16-
- [ ] Make sure the `oxide` SDK dependency is up to date with the latest release.
17-
- [ ] Generate changelog by running `make changelog` and add date of the release to the title.
14+
- [ ] Update the Terraform configuration version constraints in the following files to use the version you want to release.
15+
- [ ] [`examples`](https://github.com/oxidecomputer/terraform-provider-oxide/tree/main/examples)
16+
- [ ] [`docs`](https://github.com/oxidecomputer/terraform-provider-oxide/tree/main/docs)
17+
- [ ] Update the following files with the version you want to release.
18+
- [ ] [`VERSION`](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/VERSION)
19+
- [ ] [`internal/provider/version.go`](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/oxide/version.go)
20+
- [ ] Update the `github.com/oxidecomputer/oxide.go` dependency to the latest release.
21+
- [ ] Generate the `CHANGELOG.md` file.
22+
- [ ] Run `make changelog`
23+
- [ ] Add the date of the release to the title
1824
- [ ] Release the new version draft by running `make tag`.
1925
- [ ] Verify the release is correct, it's being created from the correct tag on GitHub, and make the release live. Note: Terraform registry will silently fail to publish if the tag is incorrect, and GitHub has a habit of messing up the tag a release is created from on occasion.
2026
- [ ] Verify the release is available on the Terraform provider registry.
21-
- [ ] If this is not a minor patch, create a new branch with the current version
22-
- [ ] Update to upcoming version in [VERSION](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/VERSION), [internal/provider/version.go](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/oxide/version.go), and
23-
create new changelog tracker file in [.changelog/](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/changelog/) for the relevant branches.
27+
- [ ] If this is a major or minor release, create a new `MAJOR.MINOR` branch from the newly created tag.
28+
- [ ] Update the following files with the upcoming version.
29+
- [ ] [`VERSION`](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/VERSION)
30+
- [ ] [`internal/provider/version.go`](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/oxide/version.go)
31+
- [ ] Create new changelog file in [.changelog/](https://github.com/oxidecomputer/terraform-provider-oxide/blob/main/changelog/) on the relevant branches.

0 commit comments

Comments
 (0)