docs: improve README with comprehensive secrets usage guide - #6033
Closed
vincent067 wants to merge 1 commit into
Closed
docs: improve README with comprehensive secrets usage guide#6033vincent067 wants to merge 1 commit into
vincent067 wants to merge 1 commit into
Conversation
Contributor
|
The readme is no longer the docs of nektos/act, please visit our nektosact.com and press suggest an edit to make changes. |
ChristopherHX
requested changes
Mar 21, 2026
ChristopherHX
left a comment
ChristopherHX
left a comment
Contributor
There was a problem hiding this comment.
Please sent to https://github.com/nektos/act-docs
Add comprehensive documentation for using secrets with act including: - Command line secrets usage with -s flag - Secrets file configuration (.secrets) - Automatic GITHUB_TOKEN handling - Practical workflow examples - Security best practices Closes nektos#2651
vincent067
force-pushed
the
docs/improve-secrets-documentation
branch
from
March 24, 2026 18:59
5f6afd9 to
f9bddb7
Compare
Contributor
|
This is just re-stating what user guide already says and also I'm pretty sure it's LLM slop. |
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
3 participants
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.
Summary
This PR adds comprehensive documentation for using secrets with
act, addressing the confusion reported in #2651.Changes
Added a new "Using Secrets with act" section to README.md covering:
Documentation Added
-sflag with both inline values and secure prompts.secretsfiles with--secret-fileflagSecurity Best Practices
.secretsto.gitignore(already present).secrets.examplepatternPractical Example
A complete workflow example showing how to use secrets in a deployment scenario, with the corresponding
actcommand.Why This Helps
New users often struggle with understanding how to pass secrets to their local workflow runs. This documentation:
actTesting
Thanks for maintaining this awesome tool!
Closes #2651