ci: use docs flavor for document generation#1336
Open
Ron (rjaegers) wants to merge 6 commits into
Open
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Ron (rjaegers)
changed the title
Ron (rjaegers)
changed the title
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 23 | 0 | 0 | 0.25s | |
| ✅ DOCKERFILE | hadolint | 4 | 0 | 0 | 0.27s | |
| ✅ JSON | npm-package-json-lint | yes | no | no | 0.71s | |
| ✅ JSON | prettier | 32 | 6 | 0 | 0 | 1.32s |
| ✅ JSON | v8r | 32 | 0 | 0 | 13.03s | |
| markdownlint | 13 | 0 | 1 | 0 | 1.38s | |
| ✅ MARKDOWN | markdown-table-formatter | 13 | 0 | 0 | 0 | 0.32s |
| ✅ REPOSITORY | checkov | yes | no | no | 28.41s | |
| ✅ REPOSITORY | gitleaks | yes | no | no | 1.32s | |
| ✅ REPOSITORY | git_diff | yes | no | no | 0.01s | |
| ✅ REPOSITORY | grype | yes | no | no | 55.5s | |
| osv-scanner | yes | 1 | no | 0.98s | ||
| ✅ REPOSITORY | secretlint | yes | no | no | 2.31s | |
| ✅ REPOSITORY | syft | yes | no | no | 2.31s | |
| ✅ REPOSITORY | trivy | yes | no | no | 14.9s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | no | 0.29s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 4.08s | |
| lychee | 100 | 1 | 0 | 54.82s | ||
| ✅ YAML | prettier | 32 | 0 | 0 | 0 | 1.33s |
| ✅ YAML | v8r | 32 | 0 | 0 | 14.01s | |
| ✅ YAML | yamllint | 32 | 0 | 0 | 1.34s |
Detailed Issues
⚠️ SPELL / lychee - 1 error
📝 Summary
---------------------
🔍 Total..........147
🔗 Unique.........123
✅ Successful.....141
⏳ Timeouts.........0
🔀 Redirected......18
👻 Excluded.........0
❓ Unknown..........0
🚫 Errors...........1
⛔ Unsupported......1
Errors in .github/TOOL_VERSION_ISSUE_TEMPLATE.md
[403] https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads (at 38:7) | Rejected status code: 403 Forbidden
Hint: Followed 18 redirects. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.
Hint: You can configure accepted/rejected response codes with `-a` or `--accept`
⚠️ MARKDOWN / markdownlint - 1 error
docs/adr/0000-record-architecture-decisions.md:30:401 error MD013/line-length Line length [Expected: 400; Actual: 520]
⚠️ REPOSITORY / osv-scanner - 1 error
Scanning dir .
Starting filesystem walk for root: /
Scanned .devcontainer/docs/requirements.txt file and found 14 packages
Scanned .devcontainer/cpp/requirements.txt file and found 20 packages
Scanned package-lock.json file and found 73 packages
Scanned test/rust/workspace/cargo/Cargo.lock file and found 1 package
Scanned test/rust/workspace/test/Cargo.lock file and found 1 package
Scanned test/rust/workspace/cortex-m/Cargo.lock file and found 20 packages
Scanned test/rust/workspace/clippy/Cargo.lock file and found 1 package
Scanned test/rust/workspace/cortex-mf/Cargo.lock file and found 20 packages
End status: 98 dirs visited, 317 inodes visited, 8 Extract calls, 30.899865ms elapsed, 30.900125ms wall time
Total 2 packages affected by 2 known vulnerabilities (0 Critical, 0 High, 0 Medium, 0 Low, 2 Unknown) from 1 ecosystem.
0 vulnerabilities can be fixed.
+-----------------------------------+------+-----------+------------+---------+---------------+------------------------------------------+
| OSV URL | CVSS | ECOSYSTEM | PACKAGE | VERSION | FIXED VERSION | SOURCE |
+-----------------------------------+------+-----------+------------+---------+---------------+------------------------------------------+
| https://osv.dev/RUSTSEC-2026-0110 | | crates.io | bare-metal | 0.2.5 | -- | test/rust/workspace/cortex-m/Cargo.lock |
| https://osv.dev/RUSTSEC-2026-0110 | | crates.io | bare-metal | 0.2.5 | -- | test/rust/workspace/cortex-mf/Cargo.lock |
+-----------------------------------+------+-----------+------------+---------+---------------+------------------------------------------+
Notices
📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)
See detailed reports in MegaLinter artifacts
You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:
- oxsecurity/megalinter/flavors/salesforce@v9.5.0 (59 linters)
- oxsecurity/megalinter/flavors/javascript@v9.5.0 (62 linters)
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@9.5.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,DOCKERFILE_HADOLINT,JSON_V8R,JSON_PRETTIER,JSON_NPM_PACKAGE_JSON_LINT,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_OSV_SCANNER,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R
Show us your support by starring ⭐ the repository
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new docs devcontainer flavor aimed at documentation generation, and wires it into CI/release automation so it is built, scanned, and maintained like the existing flavors.
Changes:
- Introduces the new
.devcontainer/docsflavor (Dockerfile + pinned apt/pip dependencies + VS Code metadata). - Adds integration tests and sample workspace files to validate PlantUML, Graphviz, and SBDL in the docs image.
- Updates GitHub workflows and release/dependency automation to include the new
docsimage.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/docs/workspace/sample.sbdl | Adds a minimal SBDL model used by docs integration tests. |
| test/docs/workspace/graph.dot | Adds a simple Graphviz graph used by docs integration tests. |
| test/docs/workspace/diagram.puml | Adds a simple PlantUML diagram used by docs integration tests. |
| test/docs/integration-tests.bats | Adds version + functional verification tests for docs tooling. |
| README.md | Documents the new docs flavor and adds it to the published image list. |
| .github/workflows/wc-document-generation.yml | Switches document generation to run inside the docs container. |
| .github/workflows/vulnerability-scan.yml | Includes the docs image in scheduled vulnerability scanning. |
| .github/workflows/update-dependencies.yml | Includes docs in dependency and VS Code extension update automation. |
| .github/workflows/release-build.yml | Includes docs in release build/release-note generation matrix. |
| .github/workflows/pr-image-cleanup.yml | Cleans up PR tags for the docs/base packages as well. |
| .github/workflows/image-cleanup.yml | Cleans up untagged/orphaned docs/base images as well. |
| .github/workflows/build-push-test.yml | Builds/tests the new docs flavor in the main build workflow matrix. |
| .github/RELEASE_TEMPLATE.md | Adds release template placeholders for the docs image. |
| .github/dependabot.yml | Adds .devcontainer/docs to Dependabot update scope. |
| .devcontainer/docs/requirements.txt | Adds pinned, hashed Python dependencies for docs tooling. |
| .devcontainer/docs/requirements.in | Adds the primary pinned Python dependency input (sbdl). |
| .devcontainer/docs/Dockerfile | Defines the docs image build (apt + pip installs). |
| .devcontainer/docs/devcontainer.json | Adds local development devcontainer definition for docs flavor. |
| .devcontainer/docs/devcontainer-metadata.json | Adds VS Code extension metadata for docs flavor. |
| .devcontainer/docs/apt-requirements.json | Adds pinned apt package versions for docs tooling. |
| .devcontainer/docs-test/devcontainer.json | Adds test devcontainer config for validating built docs images. |
Comment on lines
+46
to
+47
| - flavor: docs | ||
| dockerfile: .devcontainer/docs/Dockerfile |
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Ron (rjaegers)
temporarily deployed
to
acceptance-testing
GitHub Actions
Inactive
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
Signed-off-by: Ron <45816308+rjaegers@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ron <45816308+rjaegers@users.noreply.github.com>
|
| generate-documents: | ||
| name: Generate Documents | ||
| runs-on: ubuntu-latest | ||
| container: ghcr.io/philips-software/amp-devcontainer-docs:edge |
| generate-documents: | ||
| name: Generate Documents | ||
| runs-on: ubuntu-latest | ||
| container: ghcr.io/philips-software/amp-devcontainer-docs:edge |
Ron (rjaegers)
temporarily deployed
to
acceptance-testing
GitHub Actions
Inactive
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🚀 Hey, I have created a Pull Request
Description of changes
✔️ Checklist