Clearly document passing inputs to the script - #603
Merged
joshmgross merged 2 commits intoMay 14, 2025
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
joshmgross
temporarily deployed
to
debug-integration-test
May 13, 2025 15:01 — with 
GitHub Actions
Inactive
Copy link
Copy Markdown
|
Hello from actions/github-script! (23886ca) |
Sorry, something went wrong.
Copy link
Copy Markdown
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies how to safely pass inputs into the script step by using environment variables instead of inline Actions expressions, and highlights the security risks of script injection.
- Adds a new Passing inputs to the script section with example usage
- Removes the outdated Use env as input snippet further down in the README
Sorry, something went wrong.
joshmgross
temporarily deployed
to
debug-integration-test
May 13, 2025 15:05 — with
GitHub Actions
Inactive
johnsudol
approved these changes
May 13, 2025
5 tasks
15 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A lot of questions we get around SyntaxErrors are due to misusing Actions Expressions with the script - https://github.com/actions/github-script/issues?q=is:issue%20state:closed%20SyntaxError
This was documented in #126, but I believe it's worth clearly highlighting the security risks of using Actions expressions within the script and moving it up in the README as it's a common scenario.