This issue is tracking steps to complete a release ensuring all artifacts are correctly produced. This covers both automated tasks and manual tasks.
Release
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.
Intiial Steps
[x] 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.
[x] Create a new tag with the same name v[MAJOR].[MINOR].0
[x] Ensure code contributions and commits are included in the release description, either by utilizing the GitHub automatic options or entering them manually.
[x] Organize the release notes into the following sections: Language-Specific Changes, SDK-Wide Changes, Documentation/Samples, Protobuf/gRPC Updates, Bugfixes/Minor Improvements, Internal Improvements
[x] Confirm documentation of any breaking changes with @fundthmcalculus @geel9 @michaeldboyd
Validation Steps
[x] Builds complete successfully
[x] Release actions complete successfully
[x] Assets — ensure the following assets have been created by the release actions and are uploaded as assets in the release
[x] Debian Package, named trinsic_X.X.0_amd64.deb
[x] Trinsic CLI tarball (for Homebrew), named trinsic-cli-X.X.0.tar.gz
[x] Trinsic CLI vendored tarball (for Homebrew), named trinsic-cli-vendor-X.X.0.tar.gz
[x] Trinsic CLI Microsoft Installer (msi), name trinsic-cli-X.X.0.msi
[x] Trinsic Java/Kotlin (jar), name trinsic-services-X.X.0.jar
[x] Package Releases — validate if packages have been correctly released
[x] golang tag (go/vX.X.0)
[x] nuget.org
[x] npmjs.com
[x] pypi.org
[x] pub.dev (Dart) - future work, this is not fully implemented
Post-release Manual Steps
[x] Swift Release — create new release in associated repository for Swift package at 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.
[x] External Tools
[x] Homebrew — to create a new tap, follow the instructions at trinsic-id/homebrew-tap by making a new PR with the required information. This step depends on a release asset package. TODO: Renovate bot can update this automatically
Description
This issue is tracking steps to complete a release ensuring all artifacts are correctly produced. This covers both automated tasks and manual tasks.
Release
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.
Intiial Steps
0
. This allows individual languages to publish hotfixes under the same version with new patch. An example version format isv1.2.0
.v[MAJOR].[MINOR].0
Validation Steps
trinsic_X.X.0_amd64.deb
trinsic-cli-X.X.0.tar.gz
trinsic-cli-vendor-X.X.0.tar.gz
trinsic-cli-X.X.0.msi
trinsic-services-X.X.0.jar
go/vX.X.0
)Post-release Manual Steps
v
. Example release format is1.2.0
.