Merge pull request #88 from sphinx-contrib/trusted-publishing

Add a deploy.yml that supports trusted publishing.

Author: ezio-melotti

.github/workflows/deploy.yml

@@ -0,0 +1,73 @@
+name: Deploy
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  # Always build & lint package.
+  build-package:
+    name: Build & verify package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: hynek/build-and-inspect-python-package@v1
+
+  # Upload to Test PyPI on every commit on main.
+  release-test-pypi:
+    name: Publish in-dev package to test.pypi.org
+    if: |
+      github.repository_owner == 'sphinx-contrib'
+      && github.event_name == 'push'
+      && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: build-package
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download packages built by build-and-inspect-python-package
+        uses: actions/download-artifact@v3
+        with:
+          name: Packages
+          path: dist
+
+      - name: Upload package to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  # Upload to real PyPI on GitHub Releases.
+  release-pypi:
+    name: Publish released package to pypi.org
+    if: |
+      github.repository_owner == 'sphinx-contrib'
+      && github.event.action == 'published'
+    runs-on: ubuntu-latest
+    needs: build-package
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download packages built by build-and-inspect-python-package
+        uses: actions/download-artifact@v3
+        with:
+          name: Packages
+          path: dist
+
+      - name: Upload package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pyproject.toml

@@ -1,6 +1,9 @@
 [build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"
+build-backend = "hatchling.build"
+requires = [
+  "hatch-vcs",
+  "hatchling",
+]
 
 [project]
 name = "sphinx-lint"
@@ -33,10 +36,11 @@ repository = "https://github.com/sphinx-contrib/sphinx-lint"
 [project.scripts]
 sphinx-lint = "sphinxlint.__main__:main"
 
-[tool.setuptools]
-packages = ["sphinxlint"]
-include-package-data = false
-dynamic.version.attr = "sphinxlint.__version__"
+[tool.hatch]
+version.source = "vcs"
+
+[tool.hatch.version.raw-options]
+local_scheme = "no-local-version"
 
 [tool.black]
 

sphinxlint/__init__.py

@@ -1,7 +1,9 @@
 """Sphinx linter."""
 
-__version__ = "0.6.8"
+import importlib.metadata
 
 from sphinxlint.sphinxlint import check_file, check_text
 
+__version__ = importlib.metadata.version("sphinx_lint")
+
 __all__ = ["check_text", "check_file"]