Automate release procedure (#950)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #859 

## Introduced changes

<!-- A brief description of the changes -->

- Added a script for updating `Cargo.toml`, `Cargo.lock` and
`CHANGELOG.md` files
- Release workflow is now also triggered from the master branch if
version in `Cargo.toml` increased

## Breaking changes

<!-- List of all breaking changes, if applicable -->

## Checklist

<!-- Make sure all of these are complete -->

- [x] Linked relevant issue
- [x] Updated relevant documentation
- [x] Added relevant tests
- [x] Performed self-review of the code
- [x] Added changes to `CHANGELOG.md`

Author: cptartur

.github/workflows/release.yml

@@ -2,6 +2,9 @@ name: Release
 
 on:
   push:
+    branches:
+      - 'master'
+  create:
     tags:
       - v[0-9]+.*
 
@@ -10,23 +13,71 @@ permissions:
 
 jobs:
   verify-version:
+    name: Verify that version that triggered this workflow is greater than most recent  release
     runs-on: ubuntu-latest
+    outputs:
+      versionIsValid: ${{ steps.validVersion.outputs.versionIsValid }}
+      version: ${{ steps.validVersion.outputs.version }}
     steps:
       - uses: actions/checkout@v4
 
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'npm'
+          cache-dependency-path: scripts/package-lock.json
+      - run: npm ci
+        working-directory: scripts
+
       - name: Get version from Cargo.toml
         id: lookupVersion
         uses: mikefarah/yq@a198f72367ce9da70b564a2cc25399de8e27bf37
         with:
           cmd: yq -oy '"v" + .workspace.package.version' 'Cargo.toml'
 
-      - name: Version check
-        if: steps.lookupVersion.outputs.result != github.ref_name
-        run: echo "Project version in Cargo.toml does not match the tag" && exit 1
+      - name: Get version from the latest releases
+        id: lookupVersionRelease
+        uses: pozetroninc/github-action-get-latest-release@master
+        with:
+          owner: foundry-rs
+          repo: starknet-foundry
+          excludes: prerelease, draft
+
+      - name: Compare versions
+        id: validVersion
+        run: |
+          RELEASE_VERSION=${{ steps.lookupVersionRelease.outputs.release }}
+          COMMIT_VERSION=${{ steps.lookupVersion.outputs.result }}
+          echo "Project version from newest release = $RELEASE_VERSION"
+          echo "Project version from this commit = $COMMIT_VERSION"
+          IS_VALID=$(node ./scripts/compareVersions.js $RELEASE_VERSION $COMMIT_VERSION)
+          echo "versionIsValid=$IS_VALID" >> "$GITHUB_OUTPUT"
+          echo "version=$COMMIT_VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Output job skipped
+        if: ${{ steps.validVersion.outputs.versionIsValid == 'false' }}
+        run: echo "Version from commit is not greater from newest release, skipping build"
+
+  create-tag:
+    name: If workflow was triggered by a push to master, create a new tag with release version
+    runs-on: ubuntu-latest
+    needs: verify-version
+    if: ${{ needs.verify-version.outputs.versionIsValid == 'true' }}
+    steps:
+      - name: Create tag action was triggered by a push
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/github-script@v6
+        with:
+          script: |
+            github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: 'refs/tags/${{ needs.verify-version.outputs.version }}',
+              sha: context.sha
+            })
 
   build-binaries:
     name: Build ${{ matrix.target }}
-    needs: verify-version
+    needs: create-tag
     runs-on: ${{ matrix.os }}
     continue-on-error: true
 
@@ -94,7 +145,7 @@ jobs:
         shell: bash
         run: |
           set -euxo pipefail
-          PKG_FULL_NAME="starknet-foundry-${{ github.ref_name }}-${{ matrix.target }}" 
+          PKG_FULL_NAME="starknet-foundry-${{ github.ref_name }}-${{ matrix.target }}"
           echo "PKG_FULL_NAME=$PKG_FULL_NAME" >> $GITHUB_ENV
 
           chmod +x ./scripts/package.sh
@@ -109,7 +160,7 @@ jobs:
   create-release:
     name: Draft release
     runs-on: ubuntu-latest
-    needs: build-binaries
+    needs: [build-binaries, verify-version]
     steps:
       - uses: actions/checkout@v4
         with:
@@ -130,8 +181,10 @@ jobs:
         uses: taiki-e/create-gh-release-action@9762dfdfe60a96b3fef6c4a0aaafd9840f1195b7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          changelog: CHANGELOG.md
+          allow-missing-changelog: false
           title: $version
-          draft: true
+          ref: refs/tags/${{ needs.verify-version.outputs.version }}
 
       - name: Upload artifacts to the release
         working-directory: artifacts

.gitignore

@@ -5,3 +5,4 @@ pyproject.toml
 target
 .vscode/
 .env
+*/node_modules

RELEASING.md

@@ -1,28 +1,14 @@
 # Instruction For Creating New Starknet Forge Releases
 
-1. Bump Starknet Foundry version in the top-level `Cargo.toml` file
-2. Regenerate locks using `cargo update -p forge cast`
-3. Update `CHANGELOG.md`
-    1. Convert the `[Unreleased]` section to `[vMAJOR.MINOR.PATCH] - year-month-date`.
-    2. Create a new `[Unreleased]` section
-4. Merge introduced changes
-5. Create a new tag in repository with format `vMAJOR.MINOR.PATCH`. This will trigger the release workflow
-6. Wait for release workflows to pass. A new draft release will be created on GitHub.
-7. Update the release contents using template below and publish it
+1. Run `./scripts/release.sh MAJOR.MINOR.PATCH`.
+2. Merge introduced changes to master branch.
+3. Wait for release workflows to pass. A new release will be created on GitHub.
 
-## Release Template
+## Manually Creating a Release
 
-Optional release description
+In case a manual creation of release is necessary, for example when
+cherry-picking changes, a release can also be triggered by creating a tag
+with the name format `vMAJOR.MINOR.PATCH`.
 
-## What's Changed
-
-- list
-- of
-- features
-
-## Compatible Scarb Versions
-
-| Tool      | Scarb Version |
-|-----------|---------------|
-| `snforge` | `X.Y.Z`       |
-| `sncast`  | `X.Y.Z`       |
+Note that in this case `CHANGELOG.md`, `Cargo.toml` and `Cargo.lock` files
+have to be updated accordingly.

scripts/compareVersions.js

@@ -0,0 +1,11 @@
+const semver = require('semver')
+
+if (process.argv.length !== 4) {
+    console.error('Two arguments requred');
+    process.exit(1);
+}
+
+const old_version = process.argv[2];
+const new_version = process.argv[3];
+
+console.log((semver.gt(new_version, old_version)).toString())

scripts/package-lock.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "semver": "^7.5.4"
+  }
+}

scripts/package.json

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+VERSION=$1
+
+sed -i.bak "s/## \[Unreleased\]/## \[Unreleased\]\n\n## \[${VERSION}\] - $(TZ=Europe/Krakow date '+%Y-%m-%d')/" CHANGELOG.md
+rm CHANGELOG.md.bak 2> /dev/null
+
+sed -i.bak "/\[workspace.package\]/,/version =/ s/version = \".*/version = \"${VERSION}\"/" Cargo.toml
+rm Cargo.toml.bak 2> /dev/null
+
+cargo update forge cast