From d7c12077c478ad3d03aeeb01e2f6917d1ac93c3a Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Mon, 2 Sep 2024 10:30:03 -0400 Subject: [PATCH] Add a section about hidden files --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 9b4d3ee4..f3cce8a9 100644 --- a/README.md +++ b/README.md @@ -417,6 +417,28 @@ jobs: overwrite: true ``` +### Uploading Hidden Files + +By default, hidden files are ignored by this action to avoid unintentionally uploading sensitive information. + +If you need to upload hidden files, you can use the `include-hidden-files` input. +Any files that contain sensitive information that should not be in the uploaded artifact can be excluded +using the `path`: + +```yaml +- uses: actions/upload-artifact@v4 + with: + name: my-artifact + include-hidden-files: true + path: | + path/output/ + !path/output/.production.env +``` + +Hidden files are defined as any file beginning with `.` or files within folders beginning with `.`. +On Windows, files and directories with the hidden attribute are not considered hidden files unless +they have the `.` prefix. + ## Limitations ### Number of Artifacts