diff --git a/.changelog/3249.internal.md b/.changelog/3249.internal.md new file mode 100644 index 00000000000..8665796bb26 --- /dev/null +++ b/.changelog/3249.internal.md @@ -0,0 +1 @@ +internal: Document how to include protocol versions in the Change Log diff --git a/docs/release-process.md b/docs/release-process.md index 8bb5cf18847..91e32c68c21 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -95,11 +95,34 @@ make changelog Review the staged changes and make appropriate adjustment to the Change Log (e.g. re-order entries, make formatting/spelling fixes, ...). -After you are content with the changes, commit them, push them to the origin -and make a pull request. +Add a table with protocol versions just below the next version's heading: + +``` +| Protocol | Version | +|:------------------|:---------:| +| Consensus | | +| Runtime Host | | +| Runtime Committee | | +``` + +where `` strings are replaced with appropriate protocol versions as +defined in [go/common/version/version.go][version-file] file. + +For example: + +| Protocol | Version | +|:------------------|:---------:| +| Consensus | 1.0.0 | +| Runtime Host | 1.0.0 | +| Runtime Committee | 1.0.0 | + +After you've made the changes, commit them, push them to the origin and make a +pull request. Once the pull request had been reviewed and merged, proceed to the next step. +[version-file]: ../go/common/version/version.go + ### Tag the next release To create a signed git tag from the latest commit in origin remote's `master`