|
| 1 | +# Release Process |
| 2 | + |
| 3 | +Follow these steps in order to perform a release: |
| 4 | + |
| 5 | +## 1. Changelog |
| 6 | +- Draft a changelog entry in `CHANGELOG.md` matching the style of existing entries. |
| 7 | +- Use today's date and the next patch version. |
| 8 | + |
| 9 | +## 2. Commit |
| 10 | +- Commit message for release changelog changes should be the version number, e.g. `v2.3.5`. |
| 11 | + |
| 12 | +## 3. Release Issue |
| 13 | +- Use the `.github/ISSUE_TEMPLATE/release_issue.md` template. |
| 14 | +- Title: `Steampipe v<version>`, label: `release`. |
| 15 | + |
| 16 | +## 4. PRs |
| 17 | +1. **Against `develop`**: Title should be `Merge branch '<branchname>' into develop`. |
| 18 | +2. **Against `main`**: Title should be `Release Steampipe v<version>`. |
| 19 | + - Body format: |
| 20 | + ``` |
| 21 | + ## Release Issue |
| 22 | + [Steampipe v<version>](link-to-release-issue) |
| 23 | +
|
| 24 | + ## Checklist |
| 25 | + - [ ] Confirmed that version has been correctly upgraded. |
| 26 | + ``` |
| 27 | + - Tag the release issue to the PR (add `release` label). |
| 28 | +
|
| 29 | +## 5. steampipe.io Changelog |
| 30 | +- Create a changelog PR in the `turbot/steampipe.io` repo. |
| 31 | +- Branch off `main`, branch name: `sp-<version without dots>` (e.g. `sp-235`). |
| 32 | +- Add a file at `content/changelog/<year>/<YYYYMMDD>-steampipe-cli-v<version-with-dashes>.md`. |
| 33 | +- Frontmatter format: |
| 34 | + ``` |
| 35 | + --- |
| 36 | + title: Steampipe CLI v<version> - <short summary> |
| 37 | + publishedAt: "<YYYY-MM-DD>T10:00:00" |
| 38 | + permalink: steampipe-cli-v<version-with-dashes> |
| 39 | + tags: cli |
| 40 | + --- |
| 41 | + ``` |
| 42 | +- Body should match the changelog content from `CHANGELOG.md`. |
| 43 | +- PR title: `Steampipe CLI v<version>`, base: `main`. |
| 44 | +
|
| 45 | +## 6. Deploy steampipe.io |
| 46 | +- After the steampipe.io changelog PR is merged, trigger the `Deploy steampipe.io` workflow in `turbot/steampipe.io` from `main`. |
| 47 | +
|
| 48 | +## 7. Close Release Issue |
| 49 | +- Check off all items in the release issue checklist as steps are completed. |
| 50 | +- Close the release issue once all steps are done. |
0 commit comments