Skip to content

Commit e19cdb4

Browse files
committed
docs: clarify glob pattern support with examples
- Added glob pattern examples to README - Updated version references to v1.2.6 - Added test script to .gitignore - Clarified that glob patterns are already supported via @actions/glob
1 parent 028ddfb commit e19cdb4

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ logs
1111
node_modules
1212
temp
1313
docs/.vitepress/cache
14+
test-artifacts/
15+
test-glob.ts

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ A GitHub Action to easily attach files to a GitHub release.
1212

1313
## Usage
1414

15-
This action allows you to attach files to a GitHub release using simple glob patterns to specify the files.
15+
This action allows you to attach files to a GitHub release using **glob patterns** to specify the files.
1616

1717
```yaml
1818
- name: Attach Files to Release
19-
uses: stacksjs/action-releaser@v1.1.0
19+
uses: stacksjs/action-releaser@v1.2.6
2020
with:
2121
files: |
2222
bin/app-linux-x64
@@ -32,6 +32,28 @@ This action allows you to attach files to a GitHub release using simple glob pat
3232
# note: 'Release notes'
3333
```
3434

35+
### Glob Pattern Support
36+
37+
The `files` input supports full glob patterns powered by [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob):
38+
39+
```yaml
40+
- name: Attach Files with Glob Patterns
41+
uses: stacksjs/[email protected]
42+
with:
43+
files: |
44+
# Match all .tar.gz files in specific directories
45+
ion-binaries/ion-linux-x64/*.tar.gz
46+
ion-binaries/ion-linux-arm64/*.tar.gz
47+
ion-binaries/ion-darwin-x64/*.tar.gz
48+
ion-binaries/ion-darwin-arm64/*.tar.gz
49+
# Match all .zip files
50+
ion-binaries/ion-windows-x64/*.zip
51+
ion-binaries/ion-windows-arm64/*.zip
52+
# Or use wildcards
53+
dist/**/*.zip
54+
build/**/app-*
55+
```
56+
3557
## Inputs
3658
3759
| Name | Description | Required | Default |
@@ -74,7 +96,7 @@ jobs:
7496
7597
# Create a release and attach files
7698
- name: Create Release and Attach Files
77-
uses: stacksjs/action-releaser@v1.1.0
99+
uses: stacksjs/action-releaser@v1.2.6
78100
with:
79101
files: |
80102
dist/app.zip
@@ -116,7 +138,7 @@ jobs:
116138
117139
# Create a release, attach files, and update Homebrew formula
118140
- name: Create Release, Attach Files, and Update Homebrew Formula
119-
uses: stacksjs/action-releaser@v1.1.0
141+
uses: stacksjs/action-releaser@v1.2.6
120142
with:
121143
files: |
122144
dist/app-darwin-arm64.tar.gz
@@ -199,7 +221,7 @@ jobs:
199221
200222
# Create a release and attach files
201223
- name: Create Release and Attach Files
202-
uses: stacksjs/action-releaser@v1.1.0
224+
uses: stacksjs/action-releaser@v1.2.6
203225
with:
204226
files: |
205227
dist/*.zip

0 commit comments

Comments
 (0)