Change regular release script to perform release on tag upload.

Remove scheduling from regular release script (because any update to the files requires a signoff by a code owner, which is infeasible) and add installation instructions to release body.

Author: Fotis Koutoulakis

.github/workflows/regular-release.yaml

@@ -1,66 +1,83 @@
 on:
-  schedule:
-#            ┌───────────── minute (0 - 59)
-#            │ ┌───────────── hour (0 - 23)
-#            │ │ ┌───────────── day of the month (1 - 31)
-#            │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
-#            │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
-#            │ │ │ │ │
-#            │ │ │ │ │
-#            │ │ │ │ │
-    - cron: '0 9 * * THU'
-      # ^ this means 9:00 AM every thursday
-      # I can’t figure out the right syntax
-      # for ‘every other thursday’
+  push:
+    tags:
+      - 'cbmc-*'
+
+name: Create Release
 
 jobs:
-  bump_cbmc_version:
-    runs-on: ubuntu-20.04
+  get-version-information:
+    name: Get Version Information
+    runs-on: ubuntu-latest
     outputs:
-      cbmc_version: ${{ steps.cbmc_version_number.outputs.CBMC_VERSION }}
-      bump_git_sha: ${{ steps.commit_bump.outputs.bump_git_sha }}
+      version: ${{ steps.split.outputs._2 }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: jungwinter/split@v1
+        id: split
         with:
-          submodules: recursive
-      - name: Get new CBMC version number
-        id: cbmc_version_number
-        run: |
-          NEW_CBMC_VERSION=$(grep '^CBMC_VERSION =' src/config.inc | cut -d = -f 2 | scripts/increment_version.sh)
-          echo ::set-env name=CBMC_VERSION::$NEW_CBMC_VERSION
-          echo ::set-output name=CBMC_VERSION::$NEW_CBMC_VERSION
-      - name: Update CBMC version
-        run: |
-          sed -i "s/CBMC_VERSION = .*/CBMC_VERSION = $CBMC_VERSION/" src/config.inc
-      - name: Set git identity to github bot
-        run: |
-          git config --local user.name db-ci-cprover
-          git config --local user.email "[email protected]"
-      - name: Commit changes
-        id: commit_bump
-        run: |
-          git commit -a -m "Bump version to $CBMC_VERSION"
-          echo "::set-output name=bump_git_sha::$(git rev-parse HEAD)"
-      - name: Push changes
-        run: |
-          git push
+          msg: ${{ github.ref }}
+          seperator: '/'
   perform-release:
-    needs: bump_cbmc_version
+    name: Perform Release
     runs-on: ubuntu-20.04
+    needs: get-version-information
     steps:
-      - uses: actions/checkout@v2
-        with:
-          # We just added a commit to master, so the default GITHUB_REF doesn’t work anymore
-          ref: master
-      - name: DEBUG show bump version
-        run: echo ${{ needs.bump_cbmc_version.outputs.CBMC_VERSION }}
+      - name: Checkout code
+        uses: actions/checkout@v2
       - name: Create release
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.DB_CI_CPROVER_ACCESS_TOKEN }}
+          CBMC_TAG: ${{ needs.get-version-information.outputs.version }}
         with:
-          tag_name: cbmc-${{ needs.bump_cbmc_version.outputs.CBMC_VERSION }}
-          release_name: cbmc-${{ needs.bump_cbmc_version.outputs.CBMC_VERSION }}
+          tag_name: ${{ env.CBMC_TAG }}
+          release_name: ${{ env.CBMC_TAG }}
+          body: |
+            This is CBMC version ${{ env.CBMC_TAG }}.
+
+            ## MacOS
+
+            On MacOS, install CBMC using [Homebrew](https://brew.sh/) with
+            ```sh
+            brew install cbmc
+            ```
+
+            or upgrade (if it's already been installed) with:
+
+            ```sh
+            brew upgrade cbmc
+            ```
+
+            ## Ubuntu
+
+            On Ubuntu, install CBMC by downloading the *.deb package below for your version of Ubuntu
+            and install with one of
+
+            ```sh
+            # Ubuntu 18:
+            $ dpkg -i ubuntu-18.04-${{ env.CBMC_TAG }}-Linux.deb
+            # Ubuntu 20:
+            $ dpkg -i ubuntu-20.04-${{ env.CBMC_TAG }}-Linux.deb
+            ```
+
+            ## Windows
+
+            On Windows, install CBMC by downloading the `${{ env.CBMC_TAG }}-win64.msi` installer
+            below, double-clicking on the installer to run it, and adding the folder
+            `C:\Program Files\cbmc\bin` in your `PATH` environment variable.
+
+            For installation from the windows command prompt, run:
+
+            ```sh
+            msiexec /i ${{ env.CBMC_TAG }}-win64.msi
+            PATH="c:\program files\cbmc\bin";%PATH%
+            ```
+
+            Note that we depend on the Visual C++ redistributables. You likely already have these,
+            if not please download and run vcredist.x64.exe from Microsoft to install them prior
+            to running cbmc, or make sure you have Visual Studio 2019 installed.
+
+            You can download either [Visual Studio 2019 Community Edition](https://visualstudio.microsoft.com/vs/community/)
+            or the [Visual C++ Redistributables](https://support.microsoft.com/en-gb/help/2977003/the-latest-supported-visual-c-downloads) from Microsoft for free.
           draft: false
           prerelease: false
-          commitish: ${{ needs.bump_cbmc_version.outputs.bump_git_sha }}