diff --git a/README.md b/README.md index 4701f78..ffab4f5 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,17 @@ would now look like: packages_dir: custom-dir/ ``` +### Disabling metadata verification + +It is recommended that you run `twine check` just after producing your files, +but this also runs `twine check` before upload. You can also disable the twine +check with: + +```yml + with: + verify_metadata: false +``` + ## License The Dockerfile and associated scripts and documentation in this project diff --git a/action.yml b/action.yml index 478f53f..a5bcd55 100644 --- a/action.yml +++ b/action.yml @@ -16,6 +16,10 @@ inputs: description: The target directory for distribution required: false default: dist + verify_metadata: + description: Check metadata before uploading + required: false + default: true branding: color: yellow icon: upload-cloud @@ -27,3 +31,4 @@ runs: - ${{ inputs.password }} - ${{ inputs.repository_url }} - ${{ inputs.packages_dir }} + - ${{ inputs.verify_metadata }} diff --git a/twine-upload.sh b/twine-upload.sh index 5c3ca96..1e718a6 100755 --- a/twine-upload.sh +++ b/twine-upload.sh @@ -28,6 +28,10 @@ then are in place should you face this problem. fi +if [[ ${INPUT_VERIFY_METADATA,,} != "false" ]] ; then + twine check ${INPUT_PACKAGES_DIR%%/}/* +fi + TWINE_USERNAME="$INPUT_USER" \ TWINE_PASSWORD="$INPUT_PASSWORD" \