diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df12e354..74547907 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,8 +104,8 @@ The CI workflows for trestle-bot leverage third party actions pinned to a hash v To generate a pin for a third party action, there should be a full length commit SHA associated with the version of the action being referenced. The pin used is the full length SHA, tag, or branch that dependabot will reference when updating dependencies and bumping versions. -- The syntax for a specified action is: `OWNER/REPOSITORY@TAG-OR-SHA` -- The syntax for a specified reusable workflow is: `OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA` +- The syntax for a specified action is: `OWNER/REPOSITORY@TAG-OR-SHA`. +- The syntax for a specified reusable workflow is: `OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA`. This approach is used for authoring CI workflows that utilize versioned actions to produce frequent updates from dependabot for python and GitHub Actions.