Merge pull request #23 from andhus/publish-workflow

[WIP] Auto publishing

Author: andhus

.coveragerc

@@ -1,3 +1,4 @@
 [run]
 branch = True
 source = dirhash
+omit = _version.py

.gitattributes

@@ -0,0 +1 @@
+src/dirhash/_version.py export-subst

.github/workflows/publish.yml

@@ -0,0 +1,128 @@
+# Based on https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]*'
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    # NOTE: tags are not present unless triggered by tag push
+    # - name: Get tags
+    #   run: git fetch --tags origin
+    # - name: List tags
+    #   run: git tag --list
+    # TODO: somehow versioneer does not pickup the tag when workflow is not triggered by a 
+    #  tag push, getting e.g. (for sister repo scantree) scantree-0+untagged.1.gd74b1d5,
+    #  see: https://github.com/andhus/scantree/actions/runs/7485873305/job/20375116541#step:7:42)
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    # TODO we need to make sure the tag matches the version!
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dirhash
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Sign and upload 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 all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/[email protected]
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/dirhash
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "versioneer==0.29"]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,7 @@
+[versioneer]
+VCS = git
+style = pep440
+versionfile_source = src/dirhash/_version.py
+versionfile_build = dirhash/_version.py
+tag_prefix = v
+parentdir_prefix = dirhash-

setup.py

@@ -2,11 +2,9 @@
 import os
 from setuptools import setup, find_packages
 
-PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
+import versioneer
 
-version = {}
-with io.open(os.path.join(PROJECT_ROOT, "src", "dirhash", "version.py")) as fp:
-    exec(fp.read(), version)
+PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
 
 DESCRIPTION = 'Python module and CLI for hashing of file system directories.'
 
@@ -18,7 +16,7 @@
 
 setup(
     name='dirhash',
-    version=version['__version__'],
+    version=versioneer.get_version(),
     description=DESCRIPTION,
     long_description=long_description,
     long_description_content_type="text/markdown",

src/dirhash/__init__.py

@@ -15,7 +15,8 @@
     CyclicLinkedDir,
 )
 
-from dirhash.version import __version__
+from . import _version
+__version__ = _version.get_versions()['version']
 
 __all__ = [
     '__version__',