Skip to content

Commit 7a7137b

Browse files
author
Nicholas Pufal
authored
Merge pull request #6 from doximity/add-security-warning
Add security warning to README
2 parents 3bfd5d0 + 8757dd8 commit 7a7137b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ branch) or a pull request number.
55

66
# Usage
77
```yaml
8-
- uses: doximity/gh-action-callback-list-files@v0.0.1
8+
- uses: doximity/gh-action-callback-list-files@v1.0.0
99
with:
1010
# Repository name with owner. For example, doximity/rake-ui
1111
# Default: ${{ github.repository }}
@@ -38,6 +38,12 @@ branch) or a pull request number.
3838
#
3939
# The return of your function is set as the `callback_return` output of this
4040
# action, allowing you to reference that return value from other steps in your workflow.
41+
#
42+
# SECURITY WARNING: make sure you only reference trusted inputs from within the callback
43+
# below. Because the code is `eval`'d this can pose a code injection risk if misused.
44+
# Read more:
45+
# https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections
46+
#
4147
# Default: return filenamesList
4248
callback: ''
4349
```
@@ -49,7 +55,7 @@ branch) or a pull request number.
4955
## List all filenames for a pull request
5056
5157
```yaml
52-
- uses: doximity/gh-action-callback-list-files@v0.0.1
58+
- uses: doximity/gh-action-callback-list-files@v1.0.0
5359
with:
5460
repository: owner/repo
5561
pr_number: 250
@@ -58,7 +64,7 @@ branch) or a pull request number.
5864
## List all filenames for master HEAD
5965
6066
```yaml
61-
- uses: doximity/gh-action-callback-list-files@v0.0.1
67+
- uses: doximity/gh-action-callback-list-files@v1.0.0
6268
with:
6369
repository: owner/repo
6470
ref: master
@@ -67,7 +73,7 @@ branch) or a pull request number.
6773
## Use action's output from another step in a workflow
6874
6975
```yaml
70-
- uses: doximity/gh-action-callback-list-files@v0.0.1
76+
- uses: doximity/gh-action-callback-list-files@v1.0.0
7177
id: check-for-graphql-changes
7278
with:
7379
repository: owner/repo

0 commit comments

Comments
 (0)