Add script to update version (#405)

* add update_version script

* add script to checklist

* fix glob

* add line

* add antora path to script

* add version bump job

* add version dep

* update RELEASING with new CI workflow

* add token for checkout

* Update .github/workflows/python-app.yml

Co-authored-by: Francisco <[email protected]>

* change dep tag to commit hash

* Update .github/workflows/python-app.yml

Co-authored-by: Martín Triay <[email protected]>

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* merge release branch to main in version job

* fix git push format

* remove blockquote

* add branch checkout to checklist

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

Co-authored-by: Martín Triay <[email protected]>
Co-authored-by: Francisco <[email protected]>

Author: 3 people

.github/workflows/python-app.yml

@@ -12,8 +12,35 @@ on:
     types: [published]
 
 jobs:
+  version:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v3
+        with:
+          ref: 'main'
+          ssh-key: ${{ secrets.SSH_KEY }}
+      - name: Set version
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+      - name: Update version
+        run: python scripts/update_version.py ${{ env.RELEASE_VERSION }}
+      - name: Auto-commit changes
+        uses: stefanzweifel/git-auto-commit-action@49620cd3ed21ee620a48530e81dba0d139c9cb80
+        with:
+          commit_message: Bump version to ${{ env.RELEASE_VERSION }}
+          create_branch: true
+          branch: release-${{ env.RELEASE_VERSION }}
+      - name: Merge changes to main
+        run: |
+          git checkout "main"
+          git merge "release-${{ env.RELEASE_VERSION }}" --no-edit
+          git push
+
   test:
     runs-on: ubuntu-latest
+    if: ${{ always() }}
+    needs: [version]
     steps:
     - uses: actions/checkout@v2
     - name: Markdown Linter

RELEASING.md

@@ -4,39 +4,21 @@ Releasing checklist:
 
 (1) Write a changelog.
 
-(2) Make sure to update SPDX license identifiers. For example:
+(2) Checkout the branch to be released. This should be `main` except in the event of a hotfix. For hotfixes, checkout the latest release branch.
 
-```cairo
-# SPDX-License-Identifier: MIT
-# OpenZeppelin Contracts for Cairo v0.1.0 (account/Account.cairo)
-```
-
-to
-
-```cairo
-# SPDX-License-Identifier: MIT
-# OpenZeppelin Contracts for Cairo v0.2.0 (account/Account.cairo)
-```
-
-(3) Update documentation version in `docs/antora.yml`
-
-```diff
- name: cairo-contracts
- title: Contracts for Cairo
--version: 0.1.0
-+version: 0.2.0
- (...)
-```
-
-(4) Create a release branch and add a tag to it. This branch can be useful if we need to push a hot fix on top of an existing release in the case of a bug.
+(3) Create a tag for the release.
 
 ```sh
-git checkout -b release-0.2.0
 git tag v0.2.0
 ```
 
-(5) Push the tag to the main repository, [triggering the CI and release process](https://github.com/OpenZeppelin/cairo-contracts/blob/b27101eb826fae73f49751fa384c2a0ff3377af2/.github/workflows/python-app.yml#L60).
+(4) Push the tag to the main repository, [triggering the CI and release process](https://github.com/OpenZeppelin/cairo-contracts/blob/b27101eb826fae73f49751fa384c2a0ff3377af2/.github/workflows/python-app.yml#L60).
 
 ```sh
 git push origin v0.2.0
 ```
+
+Note that the CI automatically:
+
+- Updates the SPDX identifiers and antora.yml versions with the pushed tag
+- Creates a release branch and adds a tag to it. This can be useful if we need to push a hot fix on top of an existing release in the case of a bug.

scripts/update_version.py

@@ -0,0 +1,30 @@
+import fileinput
+import sys
+from pathlib import Path
+
+CURRENT_VERSION = "v0.2.1"
+ANTORA_PATH = "docs/antora.yml"
+
+
+def main():
+    new_version = str(sys.argv[1])
+    path = Path("src")
+    for p in path.glob("**/*.cairo"):
+        _update_version(p, new_version)
+    _update_version(ANTORA_PATH, new_version)
+    _update_version("scripts/update_version.py", new_version)
+
+
+def _update_version(path, version):
+    with fileinput.input(path, inplace=True) as file:
+        for line in file:
+            old, new = CURRENT_VERSION, version
+            if path == ANTORA_PATH:
+                old = old.strip("v")
+                new = new.strip("v")
+            new_line = line.replace(old, new)
+            print(new_line, end="")
+
+
+if __name__ == "__main__":
+    main()