Skip to content

README.md

Latest commit

 

History

History
58 lines (37 loc) · 2.88 KB

README.md

File metadata and controls

58 lines (37 loc) · 2.88 KB

publish-python-package

Publishes a Python package using PDM.

🃏Example

steps:
  - uses: actions/checkout@v4

  - uses: giancosta86/aurora-github/actions/publish-python-package@v10
    with:
      index-user: __token__
      index-secret: ${{ secrets.PYPI_TOKEN }}

Please, note: this action is designed for publication only - not for verification: you may want to use verify-python-package for that.

💡How it works

  1. Run enforce-branch-version, forwarding the enforce-branch-version input to its mode input.

  2. If the pdm command is not installed (at the requested pdm-version, if declared), install it via pipx; upon installation, the latest version will be retrieved if pdm-version is not specified.

  3. Run publish-github-pages on website-directory, with the optional flag enabled.

  4. Run pdm publish, passing the index- inputs as environment variables; if dry-run is enabled, just perform a pdm build, skipping actual deployment.

☑️Requirements

  • pipx is mandatory when PDM has to be installed.

  • The requirements for publish-github-pages if website-directory references an existing directory.

  • Before the first publication, running with dry-run set to true is recommended.

📥Inputs

Name Type Description Default value
dry-run boolean Run a simulated publication false
pdm-version string Version of PDM that should be used
index-url string URL of the target index
index-user string User for publishing to the index
index-secret string Password/token for publishing to the index
website-directory string Relative directory containing the project website website
enforce-branch-version inject,check,skip How the branch version should be enforced inject
project-directory string The directory containing pyproject.toml .

🌐Further references