From b885e7bcf27993ca4ed742d95709f8fd19345e87 Mon Sep 17 00:00:00 2001
From: Michael Tautschnig <tautschn@amazon.com>
Date: Fri, 23 Aug 2024 11:26:57 +0000
Subject: [PATCH] Automatically produce a CBMC release twice per month

This new workflow will create a pull request proposing a CBMC release
every 14th and 28th of each month.
---
 .github/workflows/release-timetabled.yaml | 70 +++++++++++++++++++++++
 doc/ADR/release_process.md                |  3 +-
 2 files changed, 72 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/release-timetabled.yaml

diff --git a/.github/workflows/release-timetabled.yaml b/.github/workflows/release-timetabled.yaml
new file mode 100644
index 00000000000..ff399cd37fc
--- /dev/null
+++ b/.github/workflows/release-timetabled.yaml
@@ -0,0 +1,70 @@
+name: Release on 14th and 28th of each month
+
+on:
+  schedule:
+    - cron: "0 8 */14 * *" # Run this on 14th and 28th of each month at 08:00
+  workflow_dispatch:       # Allow manual dispatching for a release at a custom point in time.
+
+permissions:
+  checks: write
+  contents: write
+  pull-requests: write
+
+jobs:
+  prepare-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Compare CBMC versions and determine next step
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          latest_release=$(gh -R diffblue/cbmc release list | grep Latest | awk '{print $3}' | cut -f2 -d-)
+          latest_release_sha=$(git ls-remote origin cbmc-$latest_release | awk '{print $1}')
+          head_sha=$(git ls-remote origin refs/heads/develop | awk '{ print $1 }')
+          echo "head_sha=$head_sha" >> $GITHUB_ENV
+          if [ x$latest_release_sha = x$head_sha ] ; then
+            # no changes since latest release
+            echo "next_step=none" >> $GITHUB_ENV
+          else
+            # create a draft release to construct release notes
+            gh release create cbmc-DRAFT --draft --generate-notes
+            gh release view cbmc-DRAFT --json body --jq '.body' > CHANGELOG.new
+            gh release delete -y cbmc-DRAFT
+            # compute the new version
+            latest_major=$(echo $latest_release | cut -f1 -d.)
+            latest_minor=$(echo $latest_release | cut -f2 -d.)
+            next_minor=$(($latest_minor + 1))
+            next_version="$latest_major.$next_minor.0"
+            echo "next_version=$next_version" >> $GITHUB_ENV
+            # produce an updated CHANGELOG
+            echo "# CBMC $next_version" > CHANGELOG.tmp
+            echo >> CHANGELOG.tmp
+            cat -s CHANGELOG.new >> CHANGELOG.tmp
+            rm CHANGELOG.new
+            cho >> CHANGELOG.tmp
+            cat CHANGELOG >> CHANGELOG.tmp
+            mv CHANGELOG.tmp CHANGELOG
+            # update version strings in source tree
+            perl -p -i -e \
+              "s/^CBMC_VERSION\s*=\s*\Q$latest_release\E/CBMC_VERSION = $next_version/" \
+               src/config.inc
+            perl -p -i -e \
+              "s/^version\s*=\s*\"\Q$latest_release\E\"/version = \"$next_version\"/" \
+               src/libcprover-rust/Cargo.toml
+            # debug logging of changes
+            git diff
+            echo "next_step=create_pr" >> $GITHUB_ENV
+          fi
+      - name: Create Pull Request
+        if: ${{ env.next_step == 'create_pr' }}
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: Release CBMC ${{ env.next_version }}
+          branch: cbmc-${{ env.next_version }}
+          delete-branch: true
+          title: 'Automatic release of CBMC ${{ env.next_version }}'
+          body: >
+            Release CBMC ${{ env.next_version }} up to the changes in ${{ env.head_sha }}.
diff --git a/doc/ADR/release_process.md b/doc/ADR/release_process.md
index 0bfcbbc8270..a756d1038bb 100644
--- a/doc/ADR/release_process.md
+++ b/doc/ADR/release_process.md
@@ -60,7 +60,8 @@ anything more, but the process is described below for reference:
 ## Versioning
 
 We adopt an approach approximating SemVer. That is, our version numbers should
-be major.minor.patch. Regular releases (as of 2022-06-23: every other week)
+be major.minor.patch. Regular releases (as of 2024-08-23: every 14th and 28th of
+each month)
 should normally increment the minor version number. This is also where we can
 deprecate undesired features, i.e., mark as deprecated, warn existing users.