Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update workflow example in the README #25

Merged
merged 2 commits into from
Apr 27, 2022

Conversation

st3fan
Copy link
Contributor

@st3fan st3fan commented Apr 12, 2022

This patch makes the following changes to the example workflow in the README.md:

  • pin the actions/checkout action to v2 instead of master
  • set persist-credentials: false as a good practice so that the $GITHUB_TOKEN is not made available to any action unless explicitly configured (checkout will sneakily write the token to disk where any step can pick it up)
  • Add a permissions section to limit the scope of the $GITHUB_TOKEN to just be able to read the repo contents and add security events.

Assuming many folks copy/paste the example workflow from the README.md, I think these are good security changes to encourage.

@st3fan st3fan marked this pull request as ready for review April 12, 2022 17:40
@CLAassistant
Copy link

CLAassistant commented Apr 12, 2022

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@st3fan st3fan changed the title Update README.md Update workflow example in the README Apr 12, 2022
@owenrumney
Copy link
Contributor

Thanks

@owenrumney owenrumney merged commit f91c59a into aquasecurity:master Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants