chore: split release issue template #2110
+141
−29
There are no files selected for viewing
This file contains hidden or 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,121 @@ | ||
| --- | ||
| name: Patch release | ||
| about: Checklist for releasing a patch version of ODK Central | ||
| title: 'Patch release vXXXX.X.Y' | ||
| type: 'Task' | ||
| labels: '' | ||
| assignees: '' | ||
| --- | ||
|
|
||
| Complete the steps below to release a patch version of ODK Central. For a major release, use the **Release** issue template instead. | ||
|
|
||
| > **Legend** | ||
| > - 🔎 Requires the second person (reviewer) | ||
|
|
||
| Releasing requires two people: one person to push PRs and complete other tasks and another person to review the PRs. | ||
|
|
||
| --- | ||
|
|
||
| ## Steps | ||
|
|
||
| - [ ] Decide the release version (`vXXXX.X.Y`). The same version is used for `central`, `central-backend`, and `central-frontend`, so the `central` release URL (`https://github.com/getodk/central/releases/tag/vXXXX.X.Y`) can be referenced from the `central-frontend` and `central-backend` release bodies. | ||
| - [ ] Write an announcement about the release for the forum. | ||
|
|
||
| ### Get the repository | ||
|
|
||
| - [ ] Get the latest version of the `central` repository locally. | ||
| - If you have **not** cloned the repository: clone it. | ||
| - If you had **already** cloned the repository: `git pull` | ||
| - [ ] Check out the correct branch. If the patch involves a single change/PR to the `central` repository, check out the `master` branch. Otherwise, a different branch will be used for the patch (possibly `next`); check out that branch. | ||
|
|
||
| ### Release `central-frontend` | ||
|
|
||
| > Optional section: skip it if no `central-frontend` changes are included in the patch. | ||
|
|
||
| - [ ] Run `npm run version` in `central-frontend`. This consumes the `.changeset/` files, bumps package versions, and updates each `CHANGELOG.md`. | ||
| - [ ] Commit the changes on a new branch (e.g., `release-version-bumps`) and open a PR targeting `master`. | ||
| - [ ] 🔎 Review the PR. Verify the version bumps and `CHANGELOG.md` entries match what's expected from the `.changeset/` files. | ||
| - [ ] Merge the PR. | ||
| - [ ] In `central-frontend`, create a minimal GitHub release on the merged commit. The tag push is what triggers `.github/workflows/wf-publish.yml` to publish packages to npm — full release notes live only in the `central` release. | ||
| - Tag: `v*.*.*` (no pre-release suffix). | ||
| - Set as the **latest release**. Don't set as a pre-release. | ||
| - Body: a single line pointing to the upcoming `central` release, e.g., `See release notes at https://github.com/getodk/central/releases/tag/vX.Y.Z`. | ||
| - [ ] Wait for `wf-publish.yml` to complete, then verify: | ||
| - The Actions run finished green. | ||
| - The expected packages were published to npm. | ||
| - Per-package tags were pushed to the repository. | ||
| - If the workflow fails, do not proceed with the rest of the release — investigate and resolve before creating the `central` release. | ||
|
|
||
| ### Release `central-backend` | ||
|
|
||
| > Optional section: skip it if no `central-backend` changes are included in the patch. | ||
|
|
||
| - [ ] Create a GitHub release on the latest `master` commit of `central-backend`. | ||
| - Tag: `v*.*.*` (no pre-release suffix). | ||
| - Set as the **latest release**. Don't set as a pre-release. | ||
| - Body: a single line pointing to the upcoming `central` release, e.g., `See release notes at https://github.com/getodk/central/releases/tag/vX.Y.Z`. | ||
|
|
||
| ### Update submodules | ||
|
|
||
| - [ ] For each of the server and client submodules, `cd` into the directory and run: | ||
| - `git fetch` | ||
| - `git switch -d origin/master` or `git checkout origin/master` | ||
| - [ ] Commit the submodule updates using a new branch (e.g., `update-submodules`). Create a new PR for the branch. | ||
| - If the only change/PR to the `central` repository is the submodule updates, target the `master` branch. Otherwise, a different branch will be used for the patch (possibly `next`); target that branch. | ||
| - [ ] 🔎 Review the PR. For each submodule, the diff in GitHub will link to a page that indicates the old and new commit hashes. | ||
|
|
||
| ### Merge | ||
|
|
||
| - [ ] If the patch involves more than a single change/PR to the `central` repository, then there should be a PR for the patch as a whole. Merge it. | ||
| - Select **"Create a merge commit"** when you merge. | ||
| - If the PR used the `next` branch, don't delete the `next` branch after merging. | ||
|
|
||
| ### Release `central` | ||
|
|
||
| - [ ] Create a GitHub release for `central`. This will also create a Git tag. | ||
| - Set as the **latest release**. Don't set as a pre-release. | ||
| - Publish once you're ready to create the release and tag. | ||
| - [ ] Add release notes to the release. | ||
|
|
||
| <details> | ||
| <summary>📋 Release notes template — expand, fill in links, and paste into the GitHub release</summary> | ||
|
|
||
| ```markdown | ||
| ## Release Notes | ||
|
|
||
| ### 🛠 Technical Changelogs | ||
| For a detailed list of technical updates, fixes, and improvements, please review the specific changelogs below: | ||
|
|
||
| <!-- CHANGELOG section anchors drop dots from the version number: 0.25.0 → #0250 --> | ||
| * [back-end](https://github.com/getodk/central-backend/blob/master/docs/api.yaml) | ||
| * [apps/central](https://github.com/getodk/central-frontend/tree/master/apps/central/CHANGELOG.md#<version-without-dots>) | ||
| * [apps/forms](https://github.com/getodk/central-frontend/tree/master/apps/forms/CHANGELOG.md#<version-without-dots>) | ||
| * [packages/web-forms](https://github.com/getodk/central-frontend/blob/master/packages/web-forms/CHANGELOG.md#<version-without-dots>) | ||
| * [packages/xforms-engine](https://github.com/getodk/central-frontend/blob/master/packages/xforms-engine/CHANGELOG.md#<version-without-dots>) | ||
| * [packages/xpath](https://github.com/getodk/central-frontend/tree/master/packages/xpath/CHANGELOG.md#<version-without-dots>) | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| ### Update API docs | ||
|
|
||
| - [ ] Update the API docs in the `docs` repository. Using a new branch in your fork of the `docs` repository, copy `central-backend/docs/api.yaml` to `docs/docs/_static/api-spec/central.yaml`. Create a new PR for the branch. | ||
| - [ ] 🔎 Review the PR. | ||
| - [ ] Merge any other relevant docs PRs. | ||
| - [ ] Check future release PRs. When you merge one of these, remove the `future release` label. | ||
|
|
||
| ### Announce the release | ||
|
|
||
| - [ ] Reply to the topic for the latest release. | ||
|
|
||
| ### Update news | ||
|
|
||
| - [ ] Create a new PR to update `central/docs/news.html`, branching off the `master` branch. | ||
| - Link to the forum post. Limit the number of news items to 2. Target the `master` branch. | ||
| - [ ] 🔎 Review the PR. Feel free to "Squash and merge" when you merge. | ||
|
|
||
| ### Update the `next` branch | ||
|
|
||
| > Do this once the news PR has been merged. | ||
|
|
||
| - [ ] If there has been a commit to the `next` branch that isn't on the `master` branch, then merge the `master` branch into the `next` branch. If there has not been a commit, then reset the `next` branch to the tip of the `master` branch. | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no client submodule any more, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've updated the step