From d99c5eca070d166b258e6c5ae136816149c1e58e Mon Sep 17 00:00:00 2001 From: Ryan Troost Date: Thu, 22 Aug 2024 14:43:51 +0000 Subject: [PATCH] update readme with section --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 0da14ce..18905fb 100644 --- a/README.md +++ b/README.md @@ -237,6 +237,29 @@ Artifacts are retained for 90 days by default. You can specify a shorter retenti The retention period must be between 1 and 90 inclusive. For more information see [artifact and log retention policies](https://docs.github.com/en/free-pro-team@latest/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy). + +### Hidden Files + +By default, hidden files are ignored by this action to avoid unintentionally uploading sensitive information. + +In versions of this action before v3.2.0, these hidden files were included by default. + +If you need to upload hidden files, you can use the `include-hidden-files` input. + +```yaml +jobs: + upload: + runs-on: ubuntu-latest + steps: + - name: Create a Hidden File + run: echo "hello from a hidden file" > .hidden-file.txt + - name: Upload Artifact + uses: actions/upload-artifact@v3 + with: + path: .hidden-file.txt + include-hidden-files: true +``` + ## Where does the upload go? At the bottom of the workflow summary page, there is a dedicated section for artifacts. Here's a screenshot of something you might see: