Skip to content

ci: build the booklet in the embedded-devcontainer-documentation container - #44

Merged
gabrielfrasantos merged 1 commit into
mainfrom
ci/use-documentation-container
Nov 7, 2026
Merged

gabrielfrasantos merged 1 commit into
mainfrom
ci/use-documentation-container

Conversation

@gabrielfrasantos

Copy link
Copy Markdown
Contributor

Summary

The Build Booklet job now runs in the embedded-devcontainer-documentation container image, pinned as v7.4.0@sha256:0537b169…. That image already contains Pandoc and the XeLaTeX tool chain, so the job no longer installs them on the runner for every build.

  • Removed setup-python and the apt-get install step.
  • The workspace is marked as a safe Git directory, because the checkout belongs to the runner user and the container runs as root.
  • The script runs with python3, which is the interpreter in the image.
  • The README points to the image for local builds.

Verification

In the documentation image, scripts/build-booklet.py --format all assembles 56 algorithm docs into 7 chapters and writes RoboticsToolbox.pdf and index.html, with exit code 0.


Generated by Claude Code

…ainer

Run the booklet job in the pinned documentation container image, which
already contains Pandoc and the XeLaTeX tool chain, instead of
installing them on the runner for every build.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014WUWh7MxCGbjgikbK3RwEv
@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown

✅⚠️MegaLinter analysis: Success with warnings

Descriptor Linter Files Fixed Errors Max errors Warnings Elapsed time
✅ ACTION actionlint 7 0 0 0.52s
✅ CPP clang-format 212 0 0 0 1.91s
✅ CPP cppcheck 212 0 0 3.67s
✅ DOCKERFILE hadolint 1 0 0 0.33s
✅ JSON jsonlint 8 0 0 0.1s
✅ JSON prettier 8 2 0 0 0.31s
✅ MARKDOWN markdownlint 84 0 0 0 2.03s
✅ MARKDOWN markdown-table-formatter 84 0 0 0 0.22s
⚠️ SPELL lychee 132 2 0 2.13s
✅ YAML prettier 12 0 0 0 0.46s
✅ YAML yamllint 12 0 0 0.51s

Detailed Issues

⚠️ SPELL / lychee - 2 errors
[ERROR] failed to verify TLS certificate: invalid peer certificate: UnknownIssuer
📝 Summary
---------------------
🔍 Total..........380
🔗 Unique.........130
✅ Successful.....368
⏳ Timeouts.........0
🔀 Redirected.......5
👻 Excluded.........9
❓ Unknown..........0
🚫 Errors...........2
⛔ Unsupported......2

Errors in .github/workflows/static-analysis.yml
[403] https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-$ (at 37:21) | Rejected status code: 403 Forbidden

Errors in doc/kinematics/InverseKinematics.md
[ERROR] https://mathweb.ucsd.edu/~sbuss/ResearchWeb/ikmethods/iksurvey.pdf (at 125:169) | SSL certificate not trusted. Use --insecure if site is trusted

Hint: Followed 5 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`

Notices

⚠️ Your configuration references items that have been removed from MegaLinter and are ignored: REPOSITORY_GITLEAKS, REPOSITORY_KICS. See Removed linters to find their replacements.

See detailed reports in MegaLinter artifacts

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@10.1.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,CPP_CPPCHECK,CPP_CLANG_FORMAT,DOCKERFILE_HADOLINT,JSON_JSONLINT,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT

MegaLinter is provided by OX Security
Show us your support by starring ⭐ the repository

@sonarqubecloud

sonarqubecloud Bot commented Nov 7, 2026

Copy link
Copy Markdown

@gabrielfrasantos
gabrielfrasantos merged commit 5bb026c into main Nov 7, 2026
11 checks passed
@gabrielfrasantos
gabrielfrasantos deleted the ci/use-documentation-container branch November 7, 2026 11:33
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