From f87692ee0d6070415d3e4f0fd0f23c08161df148 Mon Sep 17 00:00:00 2001
From: Michael Tautschnig <tautschn@amazon.com>
Date: Thu, 10 Dec 2020 18:00:37 +0000
Subject: [PATCH 1/2] Automatically create release tags via GitHub actions

Release tags are now created automatically when including an indicator
(see updated documentation) in the commit message.
---
 .github/workflows/create-release-tag.yaml | 34 +++++++++++++++++++++++
 doc/ADR/release_process.md                | 13 ++++-----
 2 files changed, 39 insertions(+), 8 deletions(-)
 create mode 100644 .github/workflows/create-release-tag.yaml

diff --git a/.github/workflows/create-release-tag.yaml b/.github/workflows/create-release-tag.yaml
new file mode 100644
index 00000000000..71e6133b738
--- /dev/null
+++ b/.github/workflows/create-release-tag.yaml
@@ -0,0 +1,34 @@
+name: Create release tag
+on:
+  push:
+    branches: [ develop ]
+
+jobs:
+  create-tag:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: '0'
+    - name: Compute new tag
+      uses: anothrNick/github-tag-action@1.33.0
+      id: dry_run
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        DEFAULT_BUMP: none
+        RELEASE_BRANCHES: develop
+        VERBOSE: false
+        DRY_RUN: true
+    - if: ${{ steps.dry_run.new_tag != "" }}
+      run: |
+        v=$(grep ^CBMC_VERSION src/config.inc | perl -p -e 's/^CBMC_VERSION\s*=\s*//')
+        echo "CBMC_VERSION: $v"
+        echo "New tag: ${{ steps.dry_run.new_tag }}"
+        test "cbmc-$v" == ${{ steps.dry_run.new_tag }}
+    - name: Bump version and push tag
+      uses: anothrNick/github-tag-action@1.33.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        DEFAULT_BUMP: none
+        RELEASE_BRANCHES: develop
+        VERBOSE: false
diff --git a/doc/ADR/release_process.md b/doc/ADR/release_process.md
index 51e2d63f83d..1f53c037408 100644
--- a/doc/ADR/release_process.md
+++ b/doc/ADR/release_process.md
@@ -11,12 +11,9 @@ The current process we follow through to make a new release is the following:
 1. At the point in time we want to make the release, we make a change to 
    `src/config.inc`, and update the configuration variable `CBMC_VERSION`.
    This is important as it informs the various tools of the current version
-   of CBMC.
-
-   (This needs to be pushed as a PR, and after it gets merged we move on to:)
-
-2. Then we make a `git tag` out of that commit, and push it to github. The
-   tag needs to be of the form `cbmc-<version>` with version being a version
+   of CBMC. The commit message must then contain one of \#major, \#minor, or
+   \#patch to inform the GitHub action that automatically creates a release tag.
+   The tag is of the form `cbmc-<version>`, with `<version>` being a version
    number of the form of `x.y.z`, with `x` denoting the major version, `y`
    denoting the minor version, and `z` identifying the patch version (useful
    for a hotfix or patch.)
@@ -24,12 +21,12 @@ The current process we follow through to make a new release is the following:
 At this point, the rest of the process is automated, so we don't need to do
 anything more, but the process is described below for reference:
 
-3. `.github/workflows/regular-release.yaml` gets triggered on the `push`
+2. `.github/workflows/regular-release.yaml` gets triggered on the `push`
    of the tag, and creates a Github release of the version that was
    described in thetag pushed (so, tag `cbmc-5.15.20` is going to
    create the release titled `cbmc-5.15.20` on the release page).
 
-4. `.github/workflows/release-packages.yaml` gets triggered automatically
+3. `.github/workflows/release-packages.yaml` gets triggered automatically
    at the creation of the release, and its job is to build packages for
    Windows, Ubuntu 18.04 and Ubuntu 20.04 (for now, we may support more
    specific Ubuntu versions later) and attaches them (after it has finished

From 5ad68038b4e64d5be73771551235b3ed7e606ed4 Mon Sep 17 00:00:00 2001
From: Michael Tautschnig <tautschn@amazon.com>
Date: Wed, 16 Dec 2020 00:39:59 +0000
Subject: [PATCH 2/2] Keep automated release tagging in dry-run mode

We should first make sure this actually works on this repository before
enabling it in production.
---
 .github/workflows/create-release-tag.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.github/workflows/create-release-tag.yaml b/.github/workflows/create-release-tag.yaml
index 71e6133b738..a467be7358b 100644
--- a/.github/workflows/create-release-tag.yaml
+++ b/.github/workflows/create-release-tag.yaml
@@ -32,3 +32,4 @@ jobs:
         DEFAULT_BUMP: none
         RELEASE_BRANCHES: develop
         VERBOSE: false
+        DRY_RUN: true