actions/gh-action-pypi-publish
Template
1
0
Fork 0
mirror of https://github.com/pypa/gh-action-pypi-publish synced 2024-11-30 21:22:28 +08:00
Code Issues Packages Projects Releases Wiki Activity
5ea9d6ed10
gh-action-pypi-publish/action.yml

106 lines
3.3 KiB
YAML
Raw Normal View History

Adapt to new yml based github actions Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
2019-08-21 04:48:52 +08:00
---
name: pypi-publish
description: Upload Python distribution packages to PyPI
inputs:
user:
description: PyPI user
required: false
default: __token__
password:
description: Password for your PyPI user or an access token
password input is no longer required, since not specifying it implies trusted publishing Signed-off-by: Asher Foa <1268088+asherf@users.noreply.github.com>
2023-04-27 23:30:43 +08:00
required: false
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
repository-url: # Canonical alias for `repository_url`
Adapt to new yml based github actions Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
2019-08-21 04:48:52 +08:00
description: The repository URL to use
required: false
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
repository_url: # DEPRECATED ALIAS; TODO: Remove in v3+
description: >-
[DEPRECATED]
The repository URL to use
deprecationMessage: >-
The inputs have been normalized to use kebab-case.
Use `repository-url` instead.
required: false
🐛Correct default upload URL close: #130
2023-03-16 16:39:57 +08:00
default: https://upload.pypi.org/legacy/
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
packages-dir: # Canonical alias for `packages_dir`
Custom dist
2019-12-06 07:25:02 +08:00
description: The target directory for distribution
required: false
🐛 Make kebab options fall back for snake_case The previous release didn't take into account the action defaults so the promised fallbacks for the old input names didn't work. This patch corrects that mistake.
2023-03-11 10:06:39 +08:00
# default: dist # TODO: uncomment once alias removed
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
packages_dir: # DEPRECATED ALIAS; TODO: Remove in v3+
description: >-
[DEPRECATED]
The target directory for distribution
deprecationMessage: >-
The inputs have been normalized to use kebab-case.
Use `packages-dir` instead.
required: false
default: dist
verify-metadata: # Canonical alias for `verify_metadata`
Use metadata_verify instead of check
2020-06-03 23:04:52 +08:00
description: Check metadata before uploading
feat: Add twine check before upload #30
2020-06-02 23:08:43 +08:00
required: false
🐛 Make kebab options fall back for snake_case The previous release didn't take into account the action defaults so the promised fallbacks for the old input names didn't work. This patch corrects that mistake.
2023-03-11 10:06:39 +08:00
# default: 'true' # TODO: uncomment once alias removed
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
verify_metadata: # DEPRECATED ALIAS; TODO: Remove in v3+
description: >-
[DEPRECATED]
Check metadata before uploading
deprecationMessage: >-
The inputs have been normalized to use kebab-case.
Use `verify-metadata` instead.
required: false
default: 'true'
skip-existing: # Canonical alias for `skip_existing`
Expose `skip_existing` setting to the end-users
2020-06-20 03:30:53 +08:00
description: >-
Do not fail if a Python package distribution
exists in the target package index
required: false
🐛 Make kebab options fall back for snake_case The previous release didn't take into account the action defaults so the promised fallbacks for the old input names didn't work. This patch corrects that mistake.
2023-03-11 10:06:39 +08:00
# default: 'false' # TODO: uncomment once alias removed
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
skip_existing: # DEPRECATED ALIAS; TODO: Remove in v3+
description: >-
[DEPRECATED]
Do not fail if a Python package distribution
exists in the target package index
deprecationMessage: >-
The inputs have been normalized to use kebab-case.
Use `skip-existing` instead.
required: false
default: 'false'
Update twine-upload.sh
2020-09-15 12:31:21 +08:00
verbose:
description: Show verbose output.
required: false
🎨Use explicit strings for action input defaults
2022-12-07 04:44:04 +08:00
default: 'false'
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
print-hash: # Canonical alias for `print_hash`
Move out the Python script from the shell script
2022-01-08 12:12:15 +08:00
description: Show hash values of files to be uploaded
Show hash values of files uploaded
2022-01-08 00:24:27 +08:00
required: false
🐛 Make kebab options fall back for snake_case The previous release didn't take into account the action defaults so the promised fallbacks for the old input names didn't work. This patch corrects that mistake.
2023-03-11 10:06:39 +08:00
# default: 'false' # TODO: uncomment once alias removed
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
print_hash: # DEPRECATED ALIAS; TODO: Remove in v3+
description: >-
[DEPRECATED]
Show hash values of files to be uploaded
deprecationMessage: >-
The inputs have been normalized to use kebab-case.
Use `print-hash` instead.
required: false
default: 'false'
Expose PEP 740 attestations functionality PR #236 This patch adds PEP 740 attestation generation to the workflow: when the Trusted Publishing flow is used, this will generate a publish attestation for each distribution being uploaded. These generated attestations are then fed into `twine`, which newly supports them via `--attestations`. Ref: https://github.com/pypi/warehouse/issues/15871
2024-09-01 08:50:29 +08:00
attestations:
description: >-
[EXPERIMENTAL]
Enable experimental support for PEP 740 attestations.
Only works with PyPI and TestPyPI via Trusted Publishing.
required: false
default: 'false'
Adapt to new yml based github actions Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
2019-08-21 04:48:52 +08:00
branding:
color: yellow
icon: upload-cloud
runs:
using: docker
image: Dockerfile
args:
Dedent sequence items in YAML
2019-08-23 19:11:24 +08:00
- ${{ inputs.user }}
- ${{ inputs.password }}
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
- ${{ inputs.repository-url }}
- ${{ inputs.packages-dir }}
- ${{ inputs.verify-metadata }}
- ${{ inputs.skip-existing }}
Update twine-upload.sh
2020-09-15 12:31:21 +08:00
- ${{ inputs.verbose }}
🎨 Convert action inputs to use kebab-case Up until now, the action input names followed the snake_case naming pattern that is well familiar to the pythonistas. But in GitHub actions, the de-facto standard is using kebab-case, which is what this patch achieves. This style helps make the keys in YAML better standardized and distinguishable from other identifiers. The old snake_case names remain functional for the time being and will not be removed until at least v3 release of this action.
2023-03-11 08:18:41 +08:00
- ${{ inputs.print-hash }}
Expose PEP 740 attestations functionality PR #236 This patch adds PEP 740 attestation generation to the workflow: when the Trusted Publishing flow is used, this will generate a publish attestation for each distribution being uploaded. These generated attestations are then fed into `twine`, which newly supports them via `--attestations`. Ref: https://github.com/pypi/warehouse/issues/15871
2024-09-01 08:50:29 +08:00
- ${{ inputs.attestations }}
Reference in New Issue Copy Permalink