Skip to content

Commit b18b1d3

Browse files
authored
Merge pull request #607 from actions/joshmgross/hidden-files-readme
Add a section about hidden files
2 parents 5076954 + d7c1207 commit b18b1d3

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,28 @@ jobs:
417417
overwrite: true
418418
```
419419

420+
### Uploading Hidden Files
421+
422+
By default, hidden files are ignored by this action to avoid unintentionally uploading sensitive information.
423+
424+
If you need to upload hidden files, you can use the `include-hidden-files` input.
425+
Any files that contain sensitive information that should not be in the uploaded artifact can be excluded
426+
using the `path`:
427+
428+
```yaml
429+
- uses: actions/upload-artifact@v4
430+
with:
431+
name: my-artifact
432+
include-hidden-files: true
433+
path: |
434+
path/output/
435+
!path/output/.production.env
436+
```
437+
438+
Hidden files are defined as any file beginning with `.` or files within folders beginning with `.`.
439+
On Windows, files and directories with the hidden attribute are not considered hidden files unless
440+
they have the `.` prefix.
441+
420442
## Limitations
421443

422444
### Number of Artifacts

0 commit comments

Comments
 (0)