Merge pull request #3098 from oasisprotocol/kostko/feature/release-pr…

…oto-versions

Remind to bump protocol versions before release

.changelog/3097.process.md

@@ -0,0 +1 @@
+Remind to bump protocol versions before release

Makefile

@@ -153,6 +153,7 @@ changelog: fetch-git
 	@$(ECHO_STDERR) "Generating Change Log for version $(NEXT_VERSION)..."
 	towncrier build --version $(NEXT_VERSION)
 	@$(ECHO_STDERR) "Next, review the staged changes, commit them and make a pull request."
+	@$(WARN_BREAKING_CHANGES)
 
 # Tag the next release.
 tag-next-release: fetch-git

common.mk

@@ -171,3 +171,14 @@ endif
 
 # List of non-trivial Change Log fragments.
 CHANGELOG_FRAGMENTS_NON_TRIVIAL := $(filter-out $(wildcard .changelog/*trivial*.md),$(wildcard .changelog/[0-9]*.md))
+
+# List of breaking Change Log fragments.
+CHANGELOG_FRAGMENTS_BREAKING := $(wildcard .changelog/*breaking*.md)
+
+# Helper that prints a warning when breaking changes are indicated by changelog fragments.
+define WARN_BREAKING_CHANGES =
+	if [[ -n "$(CHANGELOG_FRAGMENTS_BREAKING)" ]]; then \
+		$(ECHO_STDERR) "$(RED)Warning: This release contains breaking changes.$(OFF)"; \
+		$(ECHO_STDERR) "$(RED)         Make sure that protocol versions were bumped.$(OFF)"; \
+	fi
+endef

docs/release-process.md

@@ -69,7 +69,15 @@ release process:
 [Change Log fragments]: ../.changelog/README.md
 [towncrier]: https://github.com/hawkowl/towncrier
 
-## Preparing a regular release
+## Preparing a Regular Release
+
+### Bump Protocol Versions
+
+Before a release, make sure that the proper protocol versions were bumped
+correctly (see [`go/common/version/version.go`]). If not, make a pull request
+that bumps the respective version(s) before proceeding with the release process.
+
+[`go/common/version/version.go`]: ../go/common/version/version.go
 
 ### Prepare the Change Log