-
Notifications
You must be signed in to change notification settings - Fork 0
Add tool version capture to Build Notes PDF #20
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
Changes from 5 commits
79482b5
7dbef7c
dd4b157
a94e120
9025fe7
fe5c315
04b6822
20f09a2
48c69df
2c77e51
2eb14b4
7a126f6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -211,6 +211,9 @@ jobs: | |
| dotnet-version: ['8.x', '9.x', '10.x'] | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Download package | ||
| uses: actions/download-artifact@v7 | ||
| with: | ||
|
|
@@ -253,13 +256,30 @@ jobs: | |
| || { echo "✗ Self-validation failed"; exit 1; } | ||
| echo "✓ Self-validation succeeded" | ||
|
|
||
| - name: Capture tool versions | ||
| shell: bash | ||
| run: | | ||
| echo "Capturing tool versions..." | ||
| # Create short job ID: int-win-8, int-win-9, int-ubuntu-8, etc. | ||
| OS_SHORT=$(echo "${{ matrix.os }}" | sed 's/windows-latest/win/;s/ubuntu-latest/ubuntu/') | ||
| DOTNET_SHORT=$(echo "${{ matrix.dotnet-version }}" | sed 's/\.x$//') | ||
| JOB_ID="int-${OS_SHORT}-${DOTNET_SHORT}" | ||
| versionmark --capture --job-id "${JOB_ID}" | ||
| echo "✓ Tool versions captured" | ||
|
|
||
| - name: Upload validation test results | ||
| if: always() | ||
| uses: actions/upload-artifact@v6 | ||
| with: | ||
| name: validation-test-results-${{ matrix.os }}-dotnet${{ matrix.dotnet-version }} | ||
| path: validation-${{ matrix.os }}-dotnet${{ matrix.dotnet-version }}.trx | ||
|
|
||
| - name: Upload version capture | ||
| uses: actions/upload-artifact@v6 | ||
| with: | ||
| name: version-capture-${{ matrix.os }}-dotnet${{ matrix.dotnet-version }} | ||
| path: versionmark-int-*.json | ||
|
|
||
| # Builds the supporting documentation including user guides, requirements, | ||
| # trace matrices, code quality reports, and build notes. | ||
| build-docs: | ||
|
|
@@ -297,6 +317,13 @@ jobs: | |
| name: codeql-sarif | ||
| path: codeql-results | ||
|
|
||
| - name: Download all version captures | ||
| uses: actions/download-artifact@v7 | ||
| with: | ||
| path: version-captures | ||
| pattern: 'version-capture-*' | ||
| continue-on-error: true | ||
|
|
||
| - name: Setup dotnet | ||
| uses: actions/setup-dotnet@v5 | ||
| with: | ||
|
|
@@ -317,6 +344,13 @@ jobs: | |
| - name: Restore Tools | ||
| run: dotnet tool restore | ||
|
|
||
| - name: Capture tool versions for build-docs | ||
| shell: bash | ||
| run: | | ||
| echo "Capturing tool versions..." | ||
| versionmark --capture --job-id "build-docs" | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This may want to be explicit about which tools to capture version information for.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in fe5c315. Now explicitly lists all tools to capture: dotnet, git, node, npm, and all dotnet tools (pandoc, weasyprint, sarifmark, sonarmark, reqstream, buildmark). |
||
| echo "✓ Tool versions captured" | ||
|
|
||
| - name: Generate Requirements Report, Justifications, and Trace Matrix | ||
| run: > | ||
| dotnet reqstream | ||
|
|
@@ -370,6 +404,20 @@ jobs: | |
| --report docs/buildnotes.md | ||
| --report-depth 1 | ||
|
|
||
| - name: Publish Tool Versions | ||
| shell: bash | ||
| run: | | ||
| echo "Publishing tool versions..." | ||
| versionmark --publish --report docs/buildnotes/versions.md --report-depth 2 \ | ||
| -- "versionmark-*.json" "version-captures/**/versionmark-*.json" | ||
| echo "✓ Tool versions published" | ||
|
|
||
| - name: Display Tool Versions Report | ||
| shell: bash | ||
| run: | | ||
| echo "=== Tool Versions Report ===" | ||
| cat docs/buildnotes/versions.md | ||
|
|
||
| - name: Generate Build Notes HTML with Pandoc | ||
|
Malcolmnixon marked this conversation as resolved.
|
||
| shell: bash | ||
| run: > | ||
|
|
||
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.
This should only capture the tool versions used in the job - in this case probably just 'dotnet'. Trying to capture all tool versions will fail because not all tools are installed.
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.
Fixed in fe5c315. Now explicitly captures only dotnet and git (the tools actually available in the integration-test job).