docs: prepping docs and actions for initial release

seandstewart · Sep 4, 2024 · 6116e20 · 6116e20
1 parent 11b408a
commit 6116e20
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 58 deletions.
diff --git a/.github/workflows/.build-matrix.yml b/.github/workflows/.build-matrix.yml
@@ -30,5 +30,5 @@ jobs:
     - name: Store dist artifacts
       uses: actions/upload-artifact@v4
       with:
-        name: typelib-dist
+        name: python-package-distributions
         path: dist
diff --git a/.github/workflows/changelog.yml → .github/workflows/docs.yml b/.github/workflows/changelog.yml → .github/workflows/docs.yml
@@ -1,22 +1,29 @@
-name: Make Changelog
+name: Make Documentation
 
 on:
   push:
-    branches:
-    - "main"
+    branches: ["main"]
+    tags: ["*"]
+
+env:
+  GIT_COMMITTER_NAME: "github-actions[bot]"
+  GIT_COMMITTER_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
 
 defaults:
   run:
     shell: bash
 
+permissions:
+  contents: write
+
 jobs:
-  changelog:
+  documentation:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest ]
-        python-version: [ "3.9" ]
+        python-version: [ "3.x" ]
     steps:
     - uses: actions/checkout@v4
     - uses: ./.github/actions/bootstrap-environ
@@ -25,4 +32,8 @@ jobs:
         python-version: ${{ matrix.python-version }}
         runner: ${{ matrix.os }}
     - name: Update the Changelog
-      run: make changelog
+      run: |
+        make changelog
+        git push origin ${{ github.ref_name }}
+    - name: Build the Docs
+      run: make docs
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -2,8 +2,7 @@ name: Publish Release
 
 on:
   push:
-    tags:
-    - '*'
+    tags: ['*']
 
 defaults:
   run:
@@ -41,49 +40,56 @@ jobs:
     - name: Store dist artifacts
       uses: actions/upload-artifact@v4
       with:
-        name: typelib-dist
+        name: python-package-distributions
         path: dist
 
-  publish-pypi:
-    runs-on: ${{ matrix.os }}
-    needs: [ build-wheels, build-sdist ]
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ ubuntu-latest ]
-        python-version: [ "3.9" ]
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    needs:
+    - build-wheels
+    - build-sdist
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/typelib
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
     steps:
-    - uses: actions/checkout@v4
-    - uses: ./.github/actions/bootstrap-environ
-      id: bootstrap-environ
-      with:
-        python-version: ${{ matrix.python-version }}
-        runner: ubuntu-latest
-    - name: Download distribution artifact
+    - name: Download all the dists
       uses: actions/download-artifact@v4
       with:
-        name: typelib-dist
-        path: dist
-    - name: Publish to PyPI
-      run: poetry publish -u $PYPI_USERNAME -p $PYPI_PASSWORD
-      env:
-        PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
 
   create-release:
-    needs: [ build-wheels, build-sdist ]
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ ubuntu-latest ]
-        python-version: [ "3.9" ]
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
     steps:
-    - name: Download distribution artifact
+    - uses: actions/checkout@v4
+    - uses: ./.github/actions/bootstrap-environ
+    - name: Download all the dists
       uses: actions/download-artifact@v4
       with:
-        name: typelib-dist
-        path: dist
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/[email protected]
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
     - name: Compile Release Notes
       run: make release-notes > release-notes.md
     - name: Report Version

diff --git a/.github/workflows/tag.yml b/.github/workflows/tag.yml
@@ -19,6 +19,10 @@ defaults:
   run:
     shell: bash
 
+env:
+  GIT_COMMITTER_NAME: "github-actions[bot]"
+  GIT_COMMITTER_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
+
 jobs:
   create-version:
     runs-on: ${{ matrix.os }}
@@ -34,12 +38,7 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
         runner: ${{ matrix.os }}
-    # In order to make a commit, we need to initialize a user.
-    - name: Initialize mandatory git config
-      run: |
-        git config user.name "GitHub actions"
-        git config user.email [email protected]
     - name: Tag New Version
       run: make release-version rule=${{ inputs.level }}
     - name: Push New Version
-      run: git push --follow-tags origin ${{ github.ref_name}}
+      run: git push --follow-tags origin ${{ github.ref_name }}
diff --git a/Makefile b/Makefile
@@ -73,9 +73,23 @@ release-version:  ## Bump the version for this package.
 
 
 report-version:  ## Show the current version of this library.
-	@poetry version -s
+	@$(VERSION_CMD)
 .PHONY: report-version
 
+docs-version:  ## Show the current version of this library as applicable for documentation.
+	@$(VERSION_CMD) | $(SED_CMD) $(DOCS_FILTER)
+.PHONY: docs-version
+
+docs: ## Build the versioned documentation
+	@mike deploy -u --push $(version) $(alias)
+.PHONY: docs
+
+VERSION_CMD ?= poetry version -s
+SED_CMD ?= sed -En
+DOCS_FILTER ?= 's/^([[:digit:]]+.[[:digit:]]+).*$$/v\1/p'
+version ?= $(shell $(VERSION_CMD) | $(SED_CMD) $(DOCS_FILTER))
+alias ?= latest
+
 changelog:  ## Compile the latest changelog for the current branch.
 	@git changelog
 	@git add CHANGELOG.md

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,6 @@
 #file: noinspection YAMLSchemaValidation
 site_name: typelib
-site_url: https://pages.github.io/python-typelib
+site_url: https://pages.github.io/python-typelib/
 repo_name: seandstewart/python-typelib
 repo_url: https://github.com/seandstewart/python-typelib
 watch: [mkdocs.yml, CHANGELOG.md, src/typelib, docs]
@@ -19,13 +19,19 @@ theme:
     - content.code.select
     - content.code.copy
     - content.code.annotate
+
+  extra:
+    version:
+      provider: mike
+      default: latest
+      alias: true
+
   palette:
   # Palette toggle for automatic mode
   - media: "(prefers-color-scheme)"
     toggle:
       icon: material/brightness-auto
       name: Switch to light mode
-
   # Palette toggle for light mode
   - media: "(prefers-color-scheme: light)"
     scheme: default
@@ -34,7 +40,6 @@ theme:
     toggle:
       icon: material/brightness-7
       name: Switch to dark mode
-
   # Palette toggle for dark mode
   - media: "(prefers-color-scheme: dark)"
     scheme: slate
@@ -43,6 +48,7 @@ theme:
     toggle:
       icon: material/brightness-4
       name: Switch to system preference
+
   font:
     text: "IBM Plex Mono"
     code: "Fira Code"
@@ -118,9 +124,3 @@ markdown_extensions:
   - toc:
       permalink: true
       permalink_title: Anchor link to this section for reference
-
-
-extra:
-  version:
-    provider: mike
-