|
| 1 | +--- |
| 2 | +name: New Release Checklist |
| 3 | +about: Maintainers checklist for publishing new releases |
| 4 | +title: New Release Checklist - vX.X.0 |
| 5 | +labels: '' |
| 6 | +assignees: tmarkovski, fundthmcalculus |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +# Description |
| 11 | + |
| 12 | +This issue is tracking steps to complete a release ensuring all artifacts are correctly produced. This covers both automated tasks and manual tasks. |
| 13 | + |
| 14 | +# Release |
| 15 | + |
| 16 | +Manual steps are instructions that need to be taken in order to have a full release on all associated repos. Validation steps consist of checklist of items to verify, to ensure all reqiuirements and releases have gone without problems and that the correct assets are created needed for the manual steps. |
| 17 | + |
| 18 | +# Validation Steps |
| 19 | + |
| 20 | +- [ ] Builds complete successfully |
| 21 | +- [ ] Release actions complete successfully |
| 22 | +- [ ] **Assets** — ensure the following assets have been created by the release actions and are uploaded as assets in the release |
| 23 | + - [ ] Debian Package, named `trinsic_X.X.0_amd64.deb` |
| 24 | + - [ ] Trinsic CLI tarball (for Homebrew), named `trinsic-cli-X.X.0.tar.gz` |
| 25 | + - [ ] Trinsic CLI vendored tarball (for Homebrew), named `trinsic-cli-vendor-X.X.0.tar.gz` |
| 26 | +- [ ] **Package Releases** — validate if packages have been correctly released |
| 27 | + - [ ] nuget.org |
| 28 | + - [ ] npmjs.com |
| 29 | + - [ ] pypi.org |
| 30 | + - [ ] rubygems.org |
| 31 | + |
| 32 | +## Manual Steps |
| 33 | + |
| 34 | +- [ ] **Github Release** — create a new release following the semantic versioning guidelines. The next available version should increase either the Major or Minor version, following the semver recommendations. Patch should be set to `0`. This allows individual languages to publish hotfixes under the same version with new patch. An example version format is `v1.2.0`. |
| 35 | + - [ ] Ensure code contributions and commits are included in the release description, either by utilizing the GitHub automatic options or entering them manually. |
| 36 | +- [ ] **Swift Release** — create new release in associated repository for Swift package at [trinsic-id/sdk-swift](https://github.com/trinsic-id/sdk-swift). The release version in this repo follows a pattern that doesn't include leading `v`. Example release format is `1.2.0`. |
| 37 | +- [ ] External Tools |
| 38 | + - [ ] **Homebrew** — to create a new tap, follow the instructions at [trinsic-id/homebrew-tap](https://github.com/trinsic-id/homebrew-tap) by making a new PR with the required information. This step depends on a release asset package. |
| 39 | + - [ ] **Windows Package Manager** (winget) — TODO: Add details |
| 40 | + - [ ] **NixOS** — TODO: Add details |
| 41 | +- [ ] **Samples** — if required, code samples at https://github.com/trinsic-id/sdk-examples should be updated to match the version |
| 42 | +- [ ] Release announced to Trinsic Team |
0 commit comments