diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..89fe3af --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,124 @@ +## +# Derived from: +# https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml +# + +name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI + +on: push + +env: + PYPI_URL: https://pypi.org/p/django-typer + PYPI_TEST_URL: https://test.pypi.org/project/django-typer + +jobs: + + build: + name: Build distribution 📦 + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + 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 Python 🐍 distribution 📦 to PyPI + if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes + needs: + - build + runs-on: ubuntu-latest + environment: + name: pypi + url: ${{ env.PYPI_URL }} + 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.10 + + github-release: + 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 all the dists + uses: actions/download-artifact@v3 + with: + name: python-package-distributions + path: dist/ + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@v3 + 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 Python 🐍 distribution 📦 to TestPyPI + needs: + - build + runs-on: ubuntu-latest + + environment: + name: testpypi + url: ${{ env.PYPI_TEST_URL }} + + 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.10 + with: + repository-url: https://test.pypi.org/legacy/ + skip-existing: true diff --git a/pyproject.toml b/pyproject.toml index a691571..8da4a5e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,13 +1,23 @@ +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" + [tool.poetry] name = "django-typer" version = "2.2.2" description = "Use Typer to define the CLI for your Django management commands." -authors = ["Brian Kohan "] +authors = [ + "Brian Kohan ", +] license = "MIT" readme = "README.md" repository = "https://github.com/bckohan/django-typer" homepage = "https://django-typer.readthedocs.io" keywords = ["django", "CLI", "management", "Typer", "commands"] +packages = [ + { include = "django_typer" } +] +exclude = ["django_typer/locale"] classifiers = [ "Environment :: Console", "Framework :: Django", @@ -37,18 +47,14 @@ classifiers = [ ] -[project.urls] -Homepage = "https://django-typer.readthedocs.io" -Documentation = "https://django-typer.readthedocs.io" -Repository = "https://github.com/bckohan/django-typer" -Issues = "https://github.com/bckohan/django-typer/issues" -Changelog = "https://django-typer.readthedocs.io/en/latest/changelog.html" -Code_of_Conduct = "https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md" +[tool.poetry.urls] +"Homepage" = "https://django-typer.readthedocs.io" +"Documentation" = "https://django-typer.readthedocs.io" +"Repository" = "https://github.com/bckohan/django-typer" +"Issues" = "https://github.com/bckohan/django-typer/issues" +"Changelog" = "https://django-typer.readthedocs.io/en/latest/changelog.html" +"Code_of_Conduct" = "https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md" -packages = [ - { include = "django_typer" } -] -exclude = ["django_typer/locale"] [tool.poetry.dependencies] python = ">=3.8,<4.0"