From c9927aa13ec4c9fdd0d4be6fee9f71317bce671b Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Thu, 26 Dec 2024 01:30:38 +0100 Subject: [PATCH 1/2] Removed reference to issue 21. --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 88a7986..38a3d10 100644 --- a/README.md +++ b/README.md @@ -60,19 +60,18 @@ jobs: | `name` | no | `'artifact'` | Name of the artifact to upload. | | `working-directory` | no | `''` | | | `path` | yes | | A list of files, directories or wildcard patterns that describes what to upload. | -| `if-no-files-found`[^3] | no | `'warn'` | The desired behavior if no files are found using the provided path.
Available Options:
 • `warn`: Output a warning but do not fail the action
 • `error`: Fail the action with an error message
 • `ignore`: Do not output any warnings or errors, the action does not fail | +| `if-no-files-found` | no | `'warn'` | The desired behavior if no files are found using the provided path.
Available Options:
 • `warn`: Output a warning but do not fail the action
 • `error`: Fail the action with an error message
 • `ignore`: Do not output any warnings or errors, the action does not fail | | `retention-days` | no | repository settings | Duration after which artifact will expire in days. 0 means using default retention.
Minimum 1 day.
Maximum 90 days unless changed from the repository settings page. | | `compression-level` | no | `6` | The level of compression for Zlib to be applied to the artifact archive.
The value can range from 0 to 9.
For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads. | | `overwrite` | no | `false` | If true, an artifact with a matching name will be deleted before a new one is uploaded.
If false, the action will fail if an artifact for the given name already exists.
Does not fail if the artifact does not exist. | | `include-hidden-files`[^2] | no | `false` | Whether to include hidden files in the provided path in the artifact.
The file contents of any hidden files in the path should be validated before enabled this to avoid uploading sensitive information. | -| `mode`[^4] | no | `'tar'` | Mode of operation. Allowed modes:
 • `tar` (default),
 • `legacy` | +| `mode`[^3] | no | `'tar'` | Mode of operation. Allowed modes:
 • `tar` (default),
 • `legacy` | | `debug` | no | `false` | Enabled debug mode. List content of the created tarball. | | `tarball-name` | no | [^1] | Filename of the embedded tarball. | [^1]: `'__pyTooling_upload_artifact__.tar'` [^2]: [Hidden files are included, when directories are uploaded bug](https://github.com/pyTooling/upload-artifact/issues/20) -[^3]: [Parameter 'if-no-files-found' has no effect bug](https://github.com/pyTooling/upload-artifact/issues/21) -[^4]: [Add a legacy mode](https://github.com/pyTooling/upload-artifact/issues/22) +[^3]: [Add a legacy mode](https://github.com/pyTooling/upload-artifact/issues/22) ### Output Parameters @@ -111,7 +110,7 @@ To ensure files are extracted and assigned to the owner/group of the extracting ⚠ BSD tar doesn't support a `--delete` option. Thus, hidden files (dot files) can't be removed (excluded) from tarballs. Removing discovered hidden files afterward from created tarballs is used on runner OS providing GNU tar. This technique -can't be applied to BSD tar. +can't be applied to BSD tar. [^2] ⚠ BSD tar doesn't support a `--verbatim-files-from` option. Thus, files starting with a dash might be interpreted by `tar` as a command line option. From 37149945ce43c4810ba3aae11cf268f23b9648e3 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Thu, 26 Dec 2024 09:42:03 +0100 Subject: [PATCH 2/2] Renamed parameter debug to investigate. --- .github/actions/check-directory-content/action.yml | 2 +- .github/workflows/ArtifactsUpload.yml | 4 ++-- README.md | 2 +- action.yml | 10 +++++----- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/actions/check-directory-content/action.yml b/.github/actions/check-directory-content/action.yml index 6fd619f..e162860 100644 --- a/.github/actions/check-directory-content/action.yml +++ b/.github/actions/check-directory-content/action.yml @@ -78,7 +78,7 @@ runs: printf "%s" "Checking '${file}' ... " if [[ -f "$file" ]]; then printf "%s\n" "${ANSI_LIGHT_RED}[UNEXPECTED]${ANSI_NOCOLOR}" - printf "::error title=%s::%s\n" "check-directory-content" "File '${file}' is unexpected." + printf "::error title=%s::%s\n" "check-directory-content" "File '${file}' isn't expected." errors=$((errors + 1)) else printf "%s\n" "${ANSI_LIGHT_GREEN}[PASSED]${ANSI_NOCOLOR}" diff --git a/.github/workflows/ArtifactsUpload.yml b/.github/workflows/ArtifactsUpload.yml index 16532fb..96cd1a3 100644 --- a/.github/workflows/ArtifactsUpload.yml +++ b/.github/workflows/ArtifactsUpload.yml @@ -52,12 +52,12 @@ jobs: bin/*.py lib/ - - name: 📤 Upload artifact '${{ matrix.os.name }}-pyTooling-release' with debug + - name: 📤 Upload artifact '${{ matrix.os.name }}-pyTooling-release' with investigate uses: pyTooling/upload-artifact@dev continue-on-error: true with: name: ${{ matrix.os.name }}-pyTooling-release - debug: true + investigate: true path: | document1.txt *.log diff --git a/README.md b/README.md index 38a3d10..64af52f 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ jobs: | `overwrite` | no | `false` | If true, an artifact with a matching name will be deleted before a new one is uploaded.
If false, the action will fail if an artifact for the given name already exists.
Does not fail if the artifact does not exist. | | `include-hidden-files`[^2] | no | `false` | Whether to include hidden files in the provided path in the artifact.
The file contents of any hidden files in the path should be validated before enabled this to avoid uploading sensitive information. | | `mode`[^3] | no | `'tar'` | Mode of operation. Allowed modes:
 • `tar` (default),
 • `legacy` | -| `debug` | no | `false` | Enabled debug mode. List content of the created tarball. | +| `investigate` | no | `false` | If enabled, list content of the created tarball. | | `tarball-name` | no | [^1] | Filename of the embedded tarball. | [^1]: `'__pyTooling_upload_artifact__.tar'` diff --git a/action.yml b/action.yml index e8475c7..45ba715 100644 --- a/action.yml +++ b/action.yml @@ -86,9 +86,9 @@ inputs: type: string required: false default: 'tar' - debug: + investigate: description: | - Enabled debug mode. List content of the created tarball. + If enabled, list content of the created tarball. type: boolean required: false default: false @@ -131,7 +131,7 @@ runs: ANSI_LIGHT_BLUE="\e[94m" ANSI_NOCOLOR=$'\x1b[0m' - if [[ "${{ inputs.debug }}" == "true" ]]; then + if [[ "${{ inputs.investigate }}" == "true" ]]; then printf "::group::${ANSI_LIGHT_BLUE}List all shell options via 'shopt' ...${ANSI_NOCOLOR}\n" shopt printf "::endgroup::\n" @@ -276,8 +276,8 @@ runs: fi - name: List content of the generated tarball - id: debug - if: inputs.mode == 'tar' && inputs.debug == 'true' + id: investigate + if: inputs.mode == 'tar' && inputs.investigate == 'true' shell: bash run: | # List content of the generated tarball