You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`version` will be set inside `pyproject.toml` - [PEP 621](https://peps.python.org/pep-0621/)
22
-
- The build backend can be specified inside `pyproject.toml` (defaults to `setuptools`) - [PEP 518](https://peps.python.org/pep-0518/)
23
+
- The build backend can be specified inside `pyproject.toml` (defaults
24
+
to `setuptools`) - [PEP 518](https://peps.python.org/pep-0518/)
23
25
24
26
<br />
25
27
@@ -30,35 +32,37 @@
30
32
31
33
## Steps
32
34
33
-
| Step | Description
34
-
|---- | -----------
35
-
| ```verifyConditions``` | <ul><li>verify the environment variable ```PYPI_TOKEN```</li><li>verify ```PYPI_TOKEN``` is authorized to publish on the specified repository</li><li>check if the packages `setuptools`, `wheel` and `twine` are installed</li></ul>
36
-
| ```prepare``` | Update the version in `pyproject.toml` (legacy: `setup.cfg`) and create the distribution packages
37
-
| ```publish``` | Publish the python package to the specified repository (default: pypi)
| ```verifyConditions``` | <ul><li>verify the environment variable ```PYPI_TOKEN```</li><li>verify ```PYPI_TOKEN``` is authorized to publish on the specified repository</li><li>check if the packages `setuptools`, `wheel` and `twine` are installed</li></ul>
38
+
| ```prepare```| Update the version in `pyproject.toml` (legacy: `setup.cfg`) and create the distribution packages
39
+
| ```publish```| Publish the python package to the specified repository (default: pypi)
|```PYPI_TOKEN```|[API token](https://test.pypi.org/help/#apitoken) for PyPI | true |
46
+
| ```PYPI_USERNAME``` | Username for PyPI | false | ```__token__```
47
+
| ```PYPI_REPO_URL``` | Repo URL for PyPI | false | See [Options](#options)
46
48
47
49
## Usage
48
50
49
-
The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration). Here is a minimal example:
51
+
The plugin can be configured in the [**semantic-release
| ```srcDir``` | str | ```.``` | source directory (defaults to current directory)
90
-
| ```distDir``` | str | ```dist``` | directory to put the source distribution archive(s) in, relative to ```srcDir```
91
-
| ```repoUrl``` | str | ```https://upload.pypi.org/legacy/``` | The repository (package index) to upload the package to.
92
-
| ```pypiPublish``` | bool | ```true``` | Whether to publish the python package to the pypi registry. If false the package version will still be updated.
93
-
| ```gpgSign``` | bool | ```false``` | Whether to sign the package using GPG. A valid PGP key must already be installed and configured on the host.
94
-
| ```gpgIdentity``` | str | ```null``` | When ```gpgSign``` is true, set the GPG identify to use when signing files. Leave empty to use the default identity.
95
-
| ```envDir``` | string \|```false``` | ```.venv``` | directory to create the virtual environment in, if set to `false` no environment will be created
| ```versionCmd``` | string | ```undefined``` | Run a custom command to update the version (e.g. `hatch version ${version}`). `srcDir` is used as working directory. `versionCmd` is required if the version is set [dynamically](https://packaging.python.org/en/latest/specifications/pyproject-toml/#dynamic)
| ```srcDir``` | str | ```.``` | source directory (defaults to current directory)
97
+
| ```distDir``` | str | ```dist``` | directory to put the source distribution archive(s) in, relative to ```srcDir```
98
+
| ```repoUrl``` | str | ```https://upload.pypi.org/legacy/``` | The repository (package index) to upload the package to.
99
+
| ```repoUsername``` | str | ```__token__``` | The repository username.
100
+
| ```repoToken``` | str | | The repository token. It's safer to set via PYPI_TOKEN environment variable.
101
+
| ```pypiPublish``` | bool | ```true``` | Whether to publish the python package to the pypi registry. If false the package version will still be updated.
102
+
| ```gpgSign``` | bool | ```false``` | Whether to sign the package using GPG. A valid PGP key must already be installed and configured on the host.
103
+
| ```gpgIdentity``` | str | ```null``` | When ```gpgSign``` is true, set the GPG identify to use when signing files. Leave empty to use the default identity.
104
+
| ```envDir``` | string \|```false``` | ```.venv``` | directory to create the virtual environment in, if set to `false` no environment will be created
| ```versionCmd``` | string | ```undefined``` | Run a custom command to update the version (e.g. `hatch version ${version}`). `srcDir` is used as working directory. `versionCmd` is required if the version is set [dynamically](https://packaging.python.org/en/latest/specifications/pyproject-toml/#dynamic)
107
+
108
+
## Publishing to multiple repositories
109
+
110
+
Using `release.config.js` you can read repository credentials from environment variables and publish to multiple
0 commit comments