build: update comments in workflows

.github/workflows/build.yml

@@ -0,0 +1,10 @@
+name: build
+
+on:
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  test:
+    uses: ./.github/workflows/tox.yml
+    secrets: inherit

.github/workflows/documentation-publish.yml → .github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Generate and Publish Documentation for OSML Imagery Toolkit
+name: docs
 
 on:
   workflow_call:
@@ -15,7 +15,7 @@ jobs:
       - uses: actions/setup-python@v3
         with:
           python-version: '3.10'
-      - name: Install dependencies
+      - name: install
         run: |
           pip install sphinx
           python -m pip install sphinx-autoapi
@@ -24,7 +24,7 @@ jobs:
       - name: Sphinx build
         run: |
           tox -e docs
-      - name: Deploy
+      - name: deploy
         uses: peaceiris/[email protected]
         with:
           publish_branch: gh-pages

.github/workflows/python-publish.yml → .github/workflows/pypi.yml

@@ -1,7 +1,7 @@
 # This workflow will upload a Python Package using Twine when a release is created
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
 
-name: Publish Python Package
+name: pypi
 
 on:
   workflow_call:
@@ -18,15 +18,14 @@ jobs:
       name: release
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python
+      - name: py3.10
         uses: actions/setup-python@v5
         with:
           python-version: '3.10'
-      - name: Install dependencies
+      - name: install
         run: |
           python -m pip install --upgrade pip
           pip install build
-      - name: Build package
+      - name: build
         run: python -m build
-      - name: Publish package
-        uses: pypa/[email protected]
+      - uses: pypa/[email protected]

.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  test:
+    uses: ./.github/workflows/tox.yml
+    secrets: inherit
+  publish:
+    needs: [Tox]
+    uses: ./.github/workflows/pypi.yml
+    secrets: inherit
+  docs:
+    needs: [PyPi]
+    uses: ./.github/workflows/docs.yml
+    secrets: inherit

.github/workflows/python-tox.yml → .github/workflows/tox.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Build/Validation with Tox
+name: tox
 
 on:
   workflow_call:
@@ -16,14 +16,14 @@ jobs:
     - uses: actions/checkout@v4
       with:
         lfs: 'true'
-    - name: Set up Python 3.10
+    - name: py3.10
       uses: actions/setup-python@v3
       with:
         python-version: "3.10"
-    - name: Install dependencies
+    - name: install
       run: |
         python -m pip install --upgrade pip tox
-    - name: Validate package with tox
+    - name: tox
       run: |
         # stop the build if there are Python syntax errors or undefined names
         tox