Package Exports
- semantic-release-pypi
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (semantic-release-pypi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
semantic-release-pypi
semantic-release plugin to publish a python package to PyPI
| Step | Description |
|---|---|
verifyConditions |
|
prepare |
Update the version in setup.cfg and create the distribution packages |
publish |
Publish the python package to the specified repository (default: pypi) |
Configuration
Environment variables
| Variable | Description | Required | Default |
|---|---|---|---|
PYPI_TOKEN |
API token for PyPI | true | |
PYPI_USERNAME |
Username for PyPI | false | __token__ |
PYPI_REPO_URL |
Repo URL for PyPI | false | See Options |
Usage
The plugin can be configured in the semantic-release configuration file:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"semantic-release-pypi",
]
}An example using Github Actions can be found in the repo semantic-release-pypi-example.
Options
| Option | Type | Default | Description |
|---|---|---|---|
setupPy |
str | ./setup.py |
location of setup.py |
distDir |
str | dist |
directory to put the source distribution archive(s) in, relative to the directory of setup.py |
repoUrl |
str | https://upload.pypi.org/legacy/ |
The repository (package index) to upload the package to. |