Merge pull request #607 from actions/joshmgross/hidden-files-readme

Add a section about hidden files
This commit is contained in:
Josh Gross 2024-09-02 10:39:50 -04:00 committed by GitHub
commit b18b1d32f3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 0 deletions

View File

@ -417,6 +417,28 @@ jobs:
overwrite: true 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 ## Limitations
### Number of Artifacts ### Number of Artifacts