trying the andruino way of versioning

Author: niden

Diff for: .github/workflows/deploy-documents.yml

@@ -9,7 +9,7 @@ env:
 on:
   push:
     branches:
-      # Branch to base "dev" website on. Set in siteversion.py also.
+      # Branch to base "dev" website on.
       - master
       # Release branches have names like 0.8.x, 0.9.x, ...
       - "[0-9]+.[0-9]+.x"
@@ -66,34 +66,56 @@ jobs:
 
       - name: Determine versioning parameters
         id: determine-versioning
-        run: |
-          # Read the first line from the VERSION file
-          LINE=$(head -n 1 ./VERSION)
-          
-          # Extract version and alias using parameter expansion
-          VERSION="${LINE%%|*}"
-          ALIAS="${LINE#*|}"
-          
-          # Print the extracted values for verification
-          echo "Version: $VERSION"
-          echo "Alias: $ALIAS"
-          
-          echo "PH_DOCS_VERSION=$VERSION" >> $GITHUB_ENV
-          echo "PH_DOCS_ALIAS=$ALIAS" >> $GITHUB_ENV
+        run: echo "data=$(poetry run python siteversion.py)" >> $GITHUB_OUTPUT
 
-      - name: Deploy
-        if: ${{ env.PH_DOCS_VERSION }} != null
+      - name: Publish documentation
+        if: fromJson(steps.determine-versioning.outputs.data).version != null
         run: |
           # Publishing implies creating a git commit on the production branch, 
           # We will need to create a user for this at some point
           echo "Deploying with Mike"
           git config user.name niden
           git config user.email [email protected]
           git fetch --no-tags --prune --depth=1 origin +refs/heads/production:refs/remotes/origin/production
-          mike deploy \
+          poetry run mike deploy \
             --update-aliases \
-            --branch production \
             --push \
-            ${{ env.PH_DOCS_VERSION }} \
-            ${{ env.PH_DOCS_ALIAS }}
+            --remote origin \
+            ${{ fromJson(steps.determine-versioning.outputs.data).version }} \
+            ${{ fromJson(steps.determine-versioning.outputs.data).alias }}
           echo "Deployed"
+
+#
+#      - name: Determine versioning parameters
+#        id: determine-versioning
+#        run: |
+#          # Read the first line from the VERSION file
+#          LINE=$(head -n 1 ./VERSION)
+#
+#          # Extract version and alias using parameter expansion
+#          VERSION="${LINE%%|*}"
+#          ALIAS="${LINE#*|}"
+#
+#          # Print the extracted values for verification
+#          echo "Version: $VERSION"
+#          echo "Alias: $ALIAS"
+#
+#          echo "PH_DOCS_VERSION=$VERSION" >> $GITHUB_ENV
+#          echo "PH_DOCS_ALIAS=$ALIAS" >> $GITHUB_ENV
+#
+#      - name: Deploy
+#        if: ${{ env.PH_DOCS_VERSION }} != null
+#        run: |
+#          # Publishing implies creating a git commit on the production branch,
+#          # We will need to create a user for this at some point
+#          echo "Deploying with Mike"
+#          git config user.name niden
+#          git config user.email [email protected]
+#          git fetch --no-tags --prune --depth=1 origin +refs/heads/production:refs/remotes/origin/production
+#          mike deploy \
+#            --update-aliases \
+#            --remote origin \
+#            --push \
+#            ${{ env.PH_DOCS_VERSION }} \
+#            ${{ env.PH_DOCS_ALIAS }}
+#          echo "Deployed"

Diff for: VERSION

@@ -1 +1 @@
-5.8|
+5.8|latest

Diff for: siteversion.py

@@ -0,0 +1,70 @@
+# Workflow inspiration and adaptation came from Andruino-Cli
+# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/siteversion.py
+
+import os
+import re
+import json
+
+from git import Repo
+
+# `master` is never to be touched. We can use that as a dev version.
+#
+# As with andruino-cli, we have the same versioning scheme for the documentation.
+# The branches that are for deployment are the ones that have the format `0.99.x`.
+
+
+DEV_BRANCHES = ["master"]  # Name of the branch used for the "dev" website source content
+
+# Get the docs version, setting the latest release as the 'latest' alias.
+def get_docs_version(ref_name, release_branches):
+    if ref_name in DEV_BRANCHES:
+        return {"version": "dev", "alias": ""}
+
+    if ref_name in release_branches:
+        # if version is latest, add an alias
+        alias = "latest" if ref_name == release_branches[0] else ""
+        # strip `.x` suffix from the branch name to get the version: 0.3.x -> 0.3
+        return {"version": ref_name[:-2], "alias": alias}
+
+    return {"version": None, "alias": None}
+
+
+# Get the names of the release branches, sorted from newest to older.
+def get_rel_branch_names(blist):
+    pattern = re.compile(r"origin/(\d+\.\d+\.x)")
+    names = []
+    for b in blist:
+        res = pattern.search(b.name)
+        if res is not None:
+            names.append(res.group(1))
+
+    # Since sorting is stable, first sort by major...
+    names = sorted(names, key=lambda x: int(x.split(".")[0]), reverse=True)
+    # ...then by minor
+    return sorted(names, key=lambda x: int(x.split(".")[1]), reverse=True)
+
+
+def main():
+    # Detect repo root folder
+    here = os.path.dirname(os.path.realpath(__file__))
+    repo_dir = os.path.join(here, "..", "..")
+
+    # Get current repo
+    repo = Repo(repo_dir)
+
+    # Get the list of release branch names
+    rel_br_names = get_rel_branch_names(repo.refs)
+
+    # Deduce docs version from current branch.
+    versioning_data = get_docs_version(repo.active_branch.name, rel_br_names)
+
+    # Return the data as JSON on stdout
+    print(json.dumps(versioning_data))
+
+
+# Usage:
+#     To run the script (must be run from within the repo tree):
+#         $python siteversion.py
+#
+if __name__ == "__main__":
+    main()