This document describes [go-cose][go-cose] project release management, which includes release criteria, versioning, supported releases, and supported upgrades.
The go-cose project maintainers strive to provide a stable go-lang implementation for interacting with [COSE][ietf-cose] constructs.
Stable implies appropriate and measured changes to the library assuring consumers have the necessary functionality to interact with COSE objects.
If you or your project require added functionality, or bug fixes, please open an issue or create a pull request.
The project welcomes all contributions from adding functionality, implementing testing, security reviews to the release management.
Each incremental alpha or rc build will bump the suffix (n) number.
It's not expected to have more than 9 alphas or rcs.
The suffix will be a single digit.
If > 9 builds do occur, the format will simply use two digit indicators (v1.0.0-alpha.10)
Branch Management
To meet the projects stability goals, go-cose does not typically operate with multiple feature branches.
All active development happens in main, with releases made on a specific commit.
Major Releases
As a best practice, consumers should opt-into new capabilities through major releases.
The go-cose project will not add new functionality to patches or minor releases as this could create a new surface area that may be exploited.
Consumers should make explicit opt-in decisions to upgrade, or possibly downgrade if necessary due to unexpected breaking changes.
The go-cose project will issue major releases when:
... (truncated)
Commits
e5c68f9 docs: update docs for release process (#193)
8c458e2 Add support for CWT Claims & Type in Protected Headers (#189)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps github.com/veraison/go-cose from 1.2.1 to 1.3.0.
Release notes
Sourced from github.com/veraison/go-cose's releases.
... (truncated)
Changelog
Sourced from github.com/veraison/go-cose's changelog.
... (truncated)
Commits
e5c68f9
docs: update docs for release process (#193)8c458e2
Add support for CWT Claims & Type in Protected Headers (#189)96ea810
Document the Release Process (#188)09d6cfa
refactor!: deprecate crypto elliptic (#187)2300d5c
Update Readme for latest release (#182)2b6f94f
docs: fix the syntax of CODEOWNERS (#180)6d7578a
chore: fix duplicated import in the example (#179)2c01a2e
Validate content type header parameter (#176)e7ac36d
Add support toCOSE_Countersignature
(RFC 9338) (#172)6e436d2
Upgrade fxamacker/cbor to v2.5.0 (#166)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show