-
Notifications
You must be signed in to change notification settings - Fork 5
Sub-workflow versioning feature #44
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
Draft
sean-sype-simmons
wants to merge
4
commits into
main
Choose a base branch
from
sean-sype-simmons/versionallthings
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -347,7 +347,12 @@ on: | |||||
| description: 'Report Sonar test coverage and other metrics to Atlassian dashboard (Irfans QA dashboard)' | ||||||
| required: false | ||||||
| type: boolean | ||||||
| default: true | ||||||
| default: true | ||||||
| quality-dashboard-version: | ||||||
| description: 'Version of quality dashboard workflow to use (e.g., main, v1.0.7)' | ||||||
| required: false | ||||||
| type: string | ||||||
| default: 'main' | ||||||
| quality-product-name: | ||||||
| description: 'Product name for quality reporting (Chef360, Courier, Inspec)' | ||||||
| required: false | ||||||
|
|
@@ -734,7 +739,7 @@ jobs: | |||||
| scc: | ||||||
| name: 'Source code complexity checks' | ||||||
| if: ${{ inputs.perform-complexity-checks == true }} | ||||||
| uses: chef/common-github-actions/.github/workflows/scc.yml@main | ||||||
| uses: chef/common-github-actions/.github/workflows/scc.yml@${{ inputs.scc-version }} | ||||||
|
sean-sype-simmons marked this conversation as resolved.
sean-sype-simmons marked this conversation as resolved.
|
||||||
| uses: chef/common-github-actions/.github/workflows/scc.yml@${{ inputs.scc-version }} | |
| uses: chef/common-github-actions/.github/workflows/scc.yml@main |
sean-sype-simmons marked this conversation as resolved.
Copilot
AI
Mar 30, 2026
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.
uses: for reusable workflows does not support interpolating the ref with expressions. This will not resolve trufflehog.yml at runtime and will fail workflow parsing/execution.
Suggested change
| uses: chef/common-github-actions/.github/workflows/trufflehog.yml@${{ inputs.trufflehog-version }} | |
| uses: chef/common-github-actions/.github/workflows/trufflehog.yml@main |
sean-sype-simmons marked this conversation as resolved.
Comment on lines
1026
to
1028
Copilot
AI
Mar 30, 2026
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.
uses: for reusable workflows does not support dynamic refs via ${{ }}. This grype.yml@${{ inputs.grype-version }} reference will not resolve; refs must be static.
sean-sype-simmons marked this conversation as resolved.
Outdated
Comment on lines
1037
to
1039
Copilot
AI
Mar 30, 2026
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.
uses: refs can’t be built dynamically with ${{ }}. This grype-hab-package-scan.yml@${{ inputs.grype-hab-workflow-version }} call will not resolve as intended.
sean-sype-simmons marked this conversation as resolved.
Copilot
AI
Mar 30, 2026
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.
uses: for reusable workflows requires a static ref; ${{ inputs.polaris-version }} won’t be expanded here. This will prevent the Polaris workflow from being called.
Suggested change
| uses: chef/common-github-actions/.github/workflows/polaris-sast.yml@${{ inputs.polaris-version }} | |
| uses: chef/common-github-actions/.github/workflows/polaris-sast.yml@main |
sean-sype-simmons marked this conversation as resolved.
Comment on lines
1615
to
1617
Copilot
AI
Mar 30, 2026
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.
uses: for reusable workflows does not support interpolating the ref with ${{ }}. sbom.yml@${{ inputs.sbom-version }} will not resolve; the ref must be static.
sean-sype-simmons marked this conversation as resolved.
Copilot
AI
Mar 30, 2026
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.
uses: refs for reusable workflows must be static; ${{ inputs.quality-dashboard-version }} will not be evaluated here. This will break the quality dashboard call.
Suggested change
| uses: chef/common-github-actions/.github/workflows/irfan-quality-dashboard.yml@${{ inputs.quality-dashboard-version }} | |
| uses: chef/common-github-actions/.github/workflows/irfan-quality-dashboard.yml@main |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,6 +6,56 @@ This document provides comprehensive information about the security and quality | |||||
|
|
||||||
| ## Pipeline Overview | ||||||
|
|
||||||
| ### Sub-Workflow Versioning | ||||||
|
|
||||||
| **NEW in v1.0.7+**: Each security scan workflow can be pinned to a specific version independently. This allows you to: | ||||||
|
|
||||||
| - **Pin stable versions** that work with your project | ||||||
| - **Update incrementally** - test one scan at a time | ||||||
| - **Avoid breaking changes** - stay on known-good versions | ||||||
| - **Roll back easily** - revert specific scans if needed | ||||||
|
|
||||||
| **Version Control Strategy:** | ||||||
|
|
||||||
| ```yaml | ||||||
| # Example: Mix stable and latest versions | ||||||
| jobs: | ||||||
| ci: | ||||||
| uses: chef/common-github-actions/.github/workflows/ci-main-pull-request.yml@v1.0.7 | ||||||
| with: | ||||||
| # Production-critical scans: pin to tested versions | ||||||
| trufflehog-version: 'v1.0.7' | ||||||
| polaris-version: 'v1.0.7' | ||||||
| sbom-version: 'v1.0.7' | ||||||
|
|
||||||
| # Non-blocking scans: use latest | ||||||
| scc-version: 'main' | ||||||
| grype-version: 'main' | ||||||
|
|
||||||
| # Your scan configurations... | ||||||
| perform-trufflehog-scan: true | ||||||
| perform-blackduck-polaris: true | ||||||
| generate-sbom: true | ||||||
| ``` | ||||||
|
|
||||||
| **Available Version Inputs:** | ||||||
|
|
||||||
| | Input | Workflow | Default | Description | | ||||||
| |-------|----------|---------|-------------| | ||||||
| | `scc-version` | scc.yml | `main` | Source code complexity | | ||||||
| | `trufflehog-version` | trufflehog.yml | `main` | Secret scanning | | ||||||
| | `grype-version` | grype.yml | `main` | Image/source scanning | | ||||||
| | `grype-hab-version` | grype-hab-package-scan.yml | `main` | Habitat package scanning | | ||||||
|
sean-sype-simmons marked this conversation as resolved.
Outdated
|
||||||
| | `polaris-version` | polaris-sast.yml | `main` | BlackDuck Polaris SAST | | ||||||
| | `sbom-version` | sbom.yml | `main` | SBOM + BlackDuck SCA | | ||||||
| | `quality-dashboard-version` | irfan-quality-dashboard.yml | `main` | Quality reporting | | ||||||
|
|
||||||
| **Recommendation:** Pin to specific versions (e.g., `v1.0.7`) for production repositories. Use `main` for development/testing repositories to get latest features. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Pipeline Overview | ||||||
|
sean-sype-simmons marked this conversation as resolved.
|
||||||
| ## Pipeline Overview | |
| ## Pipeline Diagram |
sean-sype-simmons marked this conversation as resolved.
Outdated
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.