Skip to content

Commit

Permalink
v1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@Paebbels
Paebbels committed Dec 26, 2024
2 parents 8eae9e1 + 3714994 commit 9157364
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/actions/check-directory-content/action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ArtifactsUpload.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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@main
continue-on-error: true
with:
name: ${{ matrix.os.name }}-pyTooling-release
debug: true
investigate: true
path: |
document1.txt
*.log
Expand Down
11 changes: 5 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/>Available Options:<br/> • `warn`: Output a warning but do not fail the action<br/> • `error`: Fail the action with an error message<br/> • `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.<br/>Available Options:<br/> • `warn`: Output a warning but do not fail the action<br/> • `error`: Fail the action with an error message<br/> • `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. <br/> Minimum 1 day.<br/> 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.<br/> The value can range from 0 to 9.<br/> 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.<br/> If false, the action will fail if an artifact for the given name already exists.<br/> 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.<br/> 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:<br/> • `tar` (default),<br/> • `legacy` |
| `debug` | no | `false` | Enabled debug mode. List content of the created tarball. |
| `mode`[^3] | no | `'tar'` | Mode of operation. Allowed modes:<br/> • `tar` (default),<br/> • `legacy` |
| `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'`
[^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

Expand Down Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 9157364

Please sign in to comment.