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

docs: authoring CI workflows for trestle-bot section in contributing guide #374

Conversation

hbraswelrh
Copy link
Contributor

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

  • This change requires a documentation update

How has this been tested?

  • The tests run to verify changes were make test, make lint, make develop, and make all from the trestle-bot Makefile.

Test Configuration:

  • Firmware version: N40ET47W (1.29)
  • Hardware: Lenovo ThinkPad P1 Gen 4i
  • Toolchain:
  • SDK:

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@hbraswelrh hbraswelrh force-pushed the 317-add-a-section-in-the-contributingmd-to-document-requirements-on-authoring-ci-workflows-in-trestle-bot branch from ac327e4 to 3147a04 Compare October 28, 2024 17:52
@hbraswelrh hbraswelrh force-pushed the 317-add-a-section-in-the-contributingmd-to-document-requirements-on-authoring-ci-workflows-in-trestle-bot branch from 3147a04 to c7971be Compare October 28, 2024 18:12
Copy link
Member

@jpower432 jpower432 left a 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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@hbraswelrh hbraswelrh left a 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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@jpower432 jpower432 left a 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
@hbraswelrh hbraswelrh merged commit 3ff220b into RedHatProductSecurity:main Nov 7, 2024
8 checks passed
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.

Add a section in the CONTRIBUTING.md to document requirements on authoring CI workflows in trestle-bot
3 participants