Skip to content

Fix docs workflow GitHub Pages deployment conflict#5

Merged
wsollers merged 3 commits into
mainfrom
copilot/fix-1325598-1087813307-e4ff934a-88e7-4d15-9259-9d9917ba7ddf
Nov 3, 2025
Merged

Fix docs workflow GitHub Pages deployment conflict#5
wsollers merged 3 commits into
mainfrom
copilot/fix-1325598-1087813307-e4ff934a-88e7-4d15-9259-9d9917ba7ddf

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 3, 2025

The docs.yml workflow's deploy-pages job conflicted with the centralized pages-deploy.yml workflow, preventing API documentation deployment.

Changes

.github/workflows/docs.yml

  • Removed deploy-pages job - workflow now only builds and uploads documentation artifact

.github/workflows/pages-deploy.yml

  • Added "Documentation" to workflow_run triggers
  • Added artifact handling for api-documentation:
    } else if ('${{ github.event.workflow_run.name }}' === 'Documentation') {
      foundDocs = await downloadArtifact(currentRunId, "api-documentation", "api-docs.zip");
    }
  • Added fallback to fetch recent CI docs when Documentation workflow triggers
  • Added extraction logic with structure detection for merging API docs into docs/api/

Result

Single deployment workflow handles all documentation sources (CI, Performance, API) with proper artifact merging.

Original prompt

look at most recent failed task to generate docs to github pages. can you fix the task


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits November 3, 2025 04:29
- Remove deploy-pages job from docs.yml (was causing conflicts)
- Add "Documentation" workflow to pages-deploy.yml triggers
- Add handling for api-documentation artifact in pages-deploy.yml
- Merge API docs into docs/api/ directory structure
- Documentation workflow now builds docs and pages-deploy.yml handles deployment

Co-authored-by: wsollers <1325598+wsollers@users.noreply.github.com>
- Add logging to show which artifact structure was detected
- Add warning when using fallback extraction method
- Show artifact contents when unexpected structure is encountered

Co-authored-by: wsollers <1325598+wsollers@users.noreply.github.com>
Copilot AI changed the title [WIP] look at most recent failed task to generate docs to github pages. can you fix the task Fix docs workflow GitHub Pages deployment conflict Nov 3, 2025
Copilot AI requested a review from wsollers November 3, 2025 04:34
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 3, 2025

📊 Code Coverage Report

Coverage: 85.1%

Coverage Badge

📋 Coverage Details
  • Build: Clang Debug with Coverage Instrumentation
  • Test Suite: All unit tests (65 tests across 22 test suites)
  • Generated: 2025-11-03T14:42:33.384Z

📁 Artifacts Generated:

  • 📄 Text report: coverage_report.txt
  • 🌐 HTML report: coverage_html/index.html
  • 📊 JSON summary: coverage_summary.json
  • ✅ Test results: test_results_coverage.xml

💡 Tip: Download the coverage artifacts to view detailed line-by-line coverage reports.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 3, 2025

🛡️ Comprehensive SAST Security Analysis

Comprehensive SAST Security Analysis Report

Analysis Date: Mon Nov 3 14:43:54 UTC 2025
Repository: wsollers/utf_strings
Commit: 0a4f662
Scan Intensity: comprehensive

Security Tools Summary

🛡️ Trivy (Vulnerability & Misconfiguration)

Summary Report


Report Summary

┌────────┬──────┬─────────────────┬─────────┐
│ Target │ Type │ Vulnerabilities │ Secrets │
├────────┼──────┼─────────────────┼─────────┤
│   -    │  -   │        -        │    -    │
└────────┴──────┴─────────────────┴─────────┘
Legend:
- '-': Not scanned
- '0': Clean (no security findings detected)

🏗️ Checkov (Infrastructure Security)

ℹ️ Scan completed - check artifacts for details

Report Summary

github_actions scan results:

Passed checks: 1252, Failed checks: 8, Skipped checks: 0

Check: CKV_GHA_7: "The build output cannot be affected by user parameters other than the build entry point and the top-level source location. GitHub Actions workflow_dispatch inputs MUST be empty. "
	FAILED for resource: on(SAST Security Scanning)
	File: /.github/workflows/sast-scanning.yml:24-35

		24 |       scan_intensity:
		25 |         description: "SAST scanning intensity level"
		26 |         required: false
		27 |         default: "comprehensive"
		28 |         type: choice
		29 |         options:
		30 |           - basic
		31 |           - comprehensive
		32 |           - deep
		33 | 
		34 | jobs:
		35 |   # ============================================================================

Check: CKV_GHA_7: "The build output cannot be affected by user parameters other than the build entry point and the top-level source location. GitHub Actions workflow_dispatch inputs MUST be empty. "
	FAILED for resource: on(Create Release)
	File: /.github/workflows/create-release.yml:10-21

		10 |       version:
		11 |         description: "Version number (e.g., 0.0.1)"
		12 |         required: true
		13 |         type: string
		14 |       create_tag:
		15 |         description: "Create git tag if it does not exist"
		16 |         required: true
		17 |         type: boolean
		18 |         default: true
		19 | 
		20 | permissions:
		21 |   contents: write

Check: CKV_GHA_7: "The build output cannot be affected by user parameters other than the build entry point and the top-level source location. GitHub Actions workflow_dispatch inputs MUST be empty. "
	FAILED for resource: on(Release Validation)
	File: /.github/workflows/release-validation.yml:8-14

		8  |       release_tag:
		9  |         description: "Release tag to validate"
		10 |         required: true
		11 |         type: string
		12 | 
		13 | jobs:
		14 |   # ============================================================================

🔐 Gitleaks (Secret Detection)

Scan Status: ✅ Primary scan completed successfully

Secrets Found: 0
No secrets detected in repository history!

🔧 Cppcheck (Static Code Analysis)

Issues Found:

  • Errors: 1
  • Warnings: 0
  • Style Issues: 0

⚠️ 1 static analysis issue(s) detected

Sample Issues

<?xml version="1.0" encoding="UTF-8"?>
<results version="2">
    <cppcheck version="2.13.0"/>
    <errors>
        <error id="syntaxError" severity="error" msg="syntax error: &lt;= &gt;" verbose="syntax error: &lt;= &gt;" file0="src/utf_codepoints.cpp">
            <location file="include/utf/utf_codepoints.hpp" line="707" column="34"/>
        </error>
        <error id="checkersReport" severity="information" msg="Active checkers: There was critical errors (use --checkers-report=&lt;filename&gt; to see details)" verbose="Active checkers: There was critical errors (use --checkers-report=&lt;filename&gt; to see details)"/>
    </errors>
</results>

🔍 Semgrep (Security Pattern Analysis)

Security Findings: 0
No security issues detected!

Next Steps

  1. Review all findings in the GitHub Security tab
  2. Prioritize critical and high severity issues
  3. Download detailed reports from workflow artifacts
  4. Implement fixes and re-run security scans
  5. Consider adjusting scan intensity for different scenarios
🔍 View scan configuration

Tools Used:

  • Trivy: Vulnerability and misconfiguration scanning
  • Checkov: Infrastructure security analysis
  • Gitleaks: Secret detection in git history
  • Cppcheck: Static code analysis for C/C++
  • Semgrep: Security pattern matching and code analysis

SARIF Results: All findings are automatically uploaded to the Security/Code Scanning tab for detailed analysis and tracking.

Scan Intensity: comprehensive

Workflow Run: View Details

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 3, 2025

🛡️ Comprehensive SAST Security Analysis

Comprehensive SAST Security Analysis Report

Analysis Date: Mon Nov 3 14:44:15 UTC 2025
Repository: wsollers/utf_strings
Commit: 0a4f662
Scan Intensity: comprehensive

Security Tools Summary

🛡️ Trivy (Vulnerability & Misconfiguration)

Summary Report


Report Summary

┌────────┬──────┬─────────────────┬─────────┐
│ Target │ Type │ Vulnerabilities │ Secrets │
├────────┼──────┼─────────────────┼─────────┤
│   -    │  -   │        -        │    -    │
└────────┴──────┴─────────────────┴─────────┘
Legend:
- '-': Not scanned
- '0': Clean (no security findings detected)

🏗️ Checkov (Infrastructure Security)

ℹ️ Scan completed - check artifacts for details

Report Summary

github_actions scan results:

Passed checks: 1252, Failed checks: 8, Skipped checks: 0

Check: CKV_GHA_7: "The build output cannot be affected by user parameters other than the build entry point and the top-level source location. GitHub Actions workflow_dispatch inputs MUST be empty. "
	FAILED for resource: on(SAST Security Scanning)
	File: /.github/workflows/sast-scanning.yml:24-35

		24 |       scan_intensity:
		25 |         description: "SAST scanning intensity level"
		26 |         required: false
		27 |         default: "comprehensive"
		28 |         type: choice
		29 |         options:
		30 |           - basic
		31 |           - comprehensive
		32 |           - deep
		33 | 
		34 | jobs:
		35 |   # ============================================================================

Check: CKV_GHA_7: "The build output cannot be affected by user parameters other than the build entry point and the top-level source location. GitHub Actions workflow_dispatch inputs MUST be empty. "
	FAILED for resource: on(Create Release)
	File: /.github/workflows/create-release.yml:10-21

		10 |       version:
		11 |         description: "Version number (e.g., 0.0.1)"
		12 |         required: true
		13 |         type: string
		14 |       create_tag:
		15 |         description: "Create git tag if it does not exist"
		16 |         required: true
		17 |         type: boolean
		18 |         default: true
		19 | 
		20 | permissions:
		21 |   contents: write

Check: CKV_GHA_7: "The build output cannot be affected by user parameters other than the build entry point and the top-level source location. GitHub Actions workflow_dispatch inputs MUST be empty. "
	FAILED for resource: on(Release Validation)
	File: /.github/workflows/release-validation.yml:8-14

		8  |       release_tag:
		9  |         description: "Release tag to validate"
		10 |         required: true
		11 |         type: string
		12 | 
		13 | jobs:
		14 |   # ============================================================================

🔐 Gitleaks (Secret Detection)

Scan Status: ✅ Primary scan completed successfully

Secrets Found: 0
No secrets detected in repository history!

🔧 Cppcheck (Static Code Analysis)

Issues Found:

  • Errors: 1
  • Warnings: 0
  • Style Issues: 0

⚠️ 1 static analysis issue(s) detected

Sample Issues

<?xml version="1.0" encoding="UTF-8"?>
<results version="2">
    <cppcheck version="2.13.0"/>
    <errors>
        <error id="syntaxError" severity="error" msg="syntax error: &lt;= &gt;" verbose="syntax error: &lt;= &gt;" file0="src/utf_codepoints.cpp">
            <location file="include/utf/utf_codepoints.hpp" line="707" column="34"/>
        </error>
        <error id="checkersReport" severity="information" msg="Active checkers: There was critical errors (use --checkers-report=&lt;filename&gt; to see details)" verbose="Active checkers: There was critical errors (use --checkers-report=&lt;filename&gt; to see details)"/>
    </errors>
</results>

🔍 Semgrep (Security Pattern Analysis)

Security Findings: 0
No security issues detected!

Next Steps

  1. Review all findings in the GitHub Security tab
  2. Prioritize critical and high severity issues
  3. Download detailed reports from workflow artifacts
  4. Implement fixes and re-run security scans
  5. Consider adjusting scan intensity for different scenarios
🔍 View scan configuration

Tools Used:

  • Trivy: Vulnerability and misconfiguration scanning
  • Checkov: Infrastructure security analysis
  • Gitleaks: Secret detection in git history
  • Cppcheck: Static code analysis for C/C++
  • Semgrep: Security pattern matching and code analysis

SARIF Results: All findings are automatically uploaded to the Security/Code Scanning tab for detailed analysis and tracking.

Scan Intensity: comprehensive

Workflow Run: View Details

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 3, 2025

📊 Code Coverage Report

Coverage: 85.1%

Coverage Badge

📋 Coverage Details
  • Build: Clang Debug with Coverage Instrumentation
  • Test Suite: All unit tests (65 tests across 22 test suites)
  • Generated: 2025-11-03T14:44:22.476Z

📁 Artifacts Generated:

  • 📄 Text report: coverage_report.txt
  • 🌐 HTML report: coverage_html/index.html
  • 📊 JSON summary: coverage_summary.json
  • ✅ Test results: test_results_coverage.xml

💡 Tip: Download the coverage artifacts to view detailed line-by-line coverage reports.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 3, 2025

Unit Test Results

 10 files   - 37  220 suites  ±0   0s ⏱️ ±0s
 65 tests ± 0   65 ✅ ±0  0 💤 ±0  0 ❌ ±0 
650 runs  ± 0  650 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 4d910ee. ± Comparison against base commit cf3dd03.

♻️ This comment has been updated with latest results.

@wsollers wsollers marked this pull request as ready for review November 3, 2025 15:29
@wsollers wsollers merged commit 4faaaef into main Nov 3, 2025
53 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.

2 participants