New workflows

.github/workflows/build.yaml

@@ -0,0 +1,35 @@
+on:
+  release:
+    types:
+      - published
+
+name: build
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout ${{ github.ref_name }}
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref_name }}
+          fetch-tags: true
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build Python Package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true

.github/workflows/documentation.yml → .github/workflows/docs.yaml

@@ -1,20 +1,16 @@
-# Deploy Velocity documentation
-name: Deploy Documentation to Pages
-
 on:
-  # trigger on push to develop also allow manual runs
   push:
-    branches: ["develop"]
-  workflow_dispatch:
+    branches:
+      - develop
+  workflow_dispatch: { }
+
+name: docs
 
-# 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
@@ -26,24 +22,24 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - name: Checkout Develop
         uses: actions/checkout@v4
         with:
-          ref: "develop"
+          ref: develop
       - name: Setup Pages
         uses: actions/configure-pages@v5
-      - name: Set up Python
+      - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-      - name: Install dependencies
+          python-version: '3.12'
+      - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
           pip install sphinx sphinx-rtd-theme sphinx-copybutton
       - name: Build Docs
         run: |
           cd docs && make html
-      - name: Upload documentation HTML files
+      - name: Upload HTML Files
         uses: actions/upload-pages-artifact@v3
         with:
           path: './docs/build/html'

.github/workflows/linter.yaml

@@ -0,0 +1,28 @@
+on:
+  push:
+    branches:
+      - develop
+      - releases/**
+  pull_request:
+    branches:
+      - develop
+      - releases/**
+
+name: Lint Code
+
+jobs:
+  lint:
+    name: Run Linter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: "${{ github.ref }}"
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      - run: |
+          python3 -m unittest

.github/workflows/release.yaml

@@ -0,0 +1,30 @@
+on:
+  push:
+    tags:
+      - v[0-9]*
+
+run-name: Release ${{ github.ref_name }}
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref }}
+      - env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          echo "LATEST_RELEASE=$(gh release list | awk '$2 == "Latest" {print $3}')" >> "$GITHUB_ENV"
+      - env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "${{ github.ref_name }}" \
+              --repo="$GITHUB_REPOSITORY" \
+              --title="${{ github.ref_name }}" \
+              --notes="Changes between: $LATEST_RELEASE..${{ github.ref_name }}\n$(git log $LATEST_RELEASE..${{ github.ref_name }} --oneline --decorate=false)"

.github/workflows/tests.yaml

@@ -0,0 +1,25 @@
+on:
+  push:
+    branches:
+      - develop
+      - releases/**
+  pull_request:
+    branches:
+      - develop
+      - releases/**
+
+name: Run Unit Tests
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: "${{ github.ref }}"
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: |
+          python3 -m unittest

README.md

@@ -2,6 +2,12 @@
 
 -----------------------------------------------------------
 
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/olcf/velocity/tests?event=push&style=flat-square&label=test)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/olcf/velocity/docs?branch=develop&event=push&style=flat-square&label=deploy%20docs)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/olcf/velocity/build?event=release&style=flat-square&label=build)
+[![PyPI - Version](https://img.shields.io/pypi/v/olcf-velocity?style=flat-square&color=%23FFD242)](https://pypi.org/project/olcf-velocity)
+[![Spack](https://img.shields.io/spack/v/py-olcf-velocity?style=flat-square&color=%230F3A80)](https://packages.spack.io/package.html?name=py-olcf-velocity)
+
 ## Description
 Velocity is a tool to help with the maintenance of container build scripts on 
 multiple systems, backends (e.g podman or apptainer) and distros.
@@ -13,4 +19,5 @@ See <https://olcf.github.io/velocity/>.
 ``` commandline
 pip install olcf-velocity
 alias velocity="python3 -m velocity"
+velocity
 ```

pyproject.toml

@@ -51,7 +51,7 @@ exclude = [
 ]
 line-length = 120
 indent-width = 4
-target-version = "py310"
+target-version = "py312"
 
 [tool.ruff.lint]
 select = ["E4", "E7", "E9", "F"]