Expose a way for an action to ask GitHub API to mask secrets in a string
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the enhancement
Some actions like https://github.com/release-drafter/release-drafter works with a lot of templating features inside an action and has output in to release notes and action output. It would be great if we had a way to mask our output for any repo or org secrets.
Code Snippet
const maskedOutput = core.maskOutput(output)
Where maskOutput would call a GitHub Action API that will mask any secrets in a string with ****.
Additional information
Somewhat of security concern for potentially leaking secrets with the intent of providing flexibility for users to generate good release notes.
https://github.com/release-drafter/release-drafter/pull/892
https://github.com/release-drafter/release-drafter/issues/847
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposed core.maskOutput(output) interface and review the linked release-drafter pull request and issue for expected behavior. Determine whether the GitHub Actions API supports masking secrets in an arbitrary string and define the security and compatibility requirements. Done means the supported behavior and integration path are established and covered by appropriate tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, typescript
- Domain
- api, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100