-
Notifications
You must be signed in to change notification settings - Fork 10
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
docs: authoring CI workflows for trestle-bot section in contributing guide #374
Conversation
ac327e4
to
3147a04
Compare
3147a04
to
c7971be
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this @hbraswelrh! I left a couple suggestions on content wording.
Co-authored-by: Jennifer Power <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the feedback! The change of verbiage better represents the purpose of pinning actions to the full length commit SHA. Additionally, using "reference" instead of pin provides a better depiction of what dependabot.yml
will use when updating dependencies and versioning.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Might be good to get another review as well from @gvauter.
…ocument-requirements-on-authoring-ci-workflows-in-trestle-bot
Description
The changes made to the
CONTRIBUTING.md
guide include a section on "Authoring CI Workflows." The changes outline the importance of using third party actions pinned to hash values for secure maintenance of dependencies and version updates. The changes made highlight the pin generation syntax that references the full length commit SHA associated with the version of the action within the action's repository.Fixes #317
Type of change
How has this been tested?
make test
,make lint
,make develop
, andmake all
from the trestle-bot Makefile.Test Configuration:
Checklist