Merge pull request #97 from ALRhub/pr_v0.3.0

New Release: 0.3.0

.github/workflows/ensure-version-consistency.yaml

@@ -0,0 +1,50 @@
+name: Ensure Version Consistency on PR to Release
+
+on:
+  pull_request:
+    branches:
+      - release
+
+jobs:
+  check_version_and_tag:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Necessary to fetch all tags for comparison
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install toml
+
+      - name: Extract version from pyproject.toml
+        run: |
+          echo "Extracting version from pyproject.toml"
+          VERSION=$(python -c 'import toml; print(toml.load("pyproject.toml")["project"]["version"])')
+          echo "Version in pyproject.toml is $VERSION"
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Get tag for the PR's head commit
+        run: |
+          PR_HEAD_SHA=$(jq -r .pull_request.head.sha < "$GITHUB_EVENT_PATH")
+          TAG=$(git tag --contains $PR_HEAD_SHA)
+          echo "Tag on PR's head commit is $TAG"
+          echo "TAG=$TAG" >> $GITHUB_ENV
+
+      - name: Compare version and tag
+        run: |
+          if [ -z "$TAG" ]; then
+            echo "Head commit of PR is not tagged. Ensure the head commit of PRs onto release is tagged with the version number."
+            exit 1
+          elif [ "$VERSION" != "$TAG" ]; then
+            echo "Version in pyproject.toml ($VERSION) does not match the git tag ($TAG)."
+            exit 1
+          else
+            echo "Version and git tag match. Check passed."
+          fi

.github/workflows/host_docs_static.yml

@@ -0,0 +1,40 @@
+name: Deploy static docs to Pages
+
+on:
+  push:
+    branches: ["release"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish-to-pypi.yml

@@ -2,45 +2,45 @@ name: Publish Python package to PyPI
 
 on:
   push:
-    tags:
-      - '*'
+    branches:
+      - release
 
 jobs:
   publish:
     name: Publish to PyPI
     runs-on: ubuntu-latest
-    if: false && startsWith(github.ref, 'refs/tags/')  # Only run on tagged commits
-
     steps:
     - name: Check out code
       uses: actions/checkout@v4
       with:
         fetch-depth: 0  # This fetches all history for all branches and tags
 
-    - name: Verify tag is on master branch
-      run: |
-        TAG_IS_ON_MASTER=$(git branch -r --contains ${{ github.ref }} | grep 'origin/master')
-        if [ -z "$TAG_IS_ON_MASTER" ]; then
-          echo "Tag is not on the master branch. Cancelling the workflow."
-          exit 1
-        fi
-        echo "Tag is on the master branch. Proceeding with the workflow."
-
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
         python-version: "3.x"
 
+    - name: Validate version against tag
+      run: |
+        VERSION=$(python -c 'import toml; print(toml.load("pyproject.toml")["project"]["version"])')
+        TAG=$(git tag --contains HEAD)
+        if [ -z "$TAG" ]; then
+          echo "Commit is not tagged. Failing the workflow."
+          exit 1
+        fi
+        if [ "$VERSION" != "$TAG" ]; then
+          echo "Version in pyproject.toml ($VERSION) does not match the git tag ($TAG). Failing the workflow."
+          exit 1
+        fi
+        echo "Version and commit tag match. Proceeding with the workflow."
+
     - name: Install pypa/build/setuptools/twine
       run: >-
         python3 -m
         pip install
         build setuptools twine
         --user
 
-    - name: Prevent fallback onto setup.py
-      run: rm setup.py
-
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
 

.gitignore

@@ -115,3 +115,7 @@ MUJOCO_LOG.TXT
 
 # vscode
 .vscode
+
+# Push HTML of docs to GitHub
+# Could be solved via a GitHub Action instead in the future, but that would use up compute for ALRhub
+!docs/build/