internal: Document how to include protocol versions in the Change Log

oasisprotocol · Sep 6, 2020 · c5279ce · c5279ce
1 parent 6fd8787
commit c5279ce
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/.changelog/3249.internal.md 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
@@ -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         | <VERSION> |
+| Runtime Host      | <VERSION> |
+| Runtime Committee | <VERSION> |
+```
+
+where `<VERSION>` 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`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		internal: Document how to include protocol versions in the Change Log