Repository navigation
feat: run the action inside the embedded-devcontainer-documentation container - #4
Merged
Merged
Conversation
…ontainer - skip setup-python when python-version is empty and use the python3 on the PATH instead - install the package into a virtual environment, so it also works with an externally managed system Python (PEP 668) - skip the Pandoc/LaTeX installation when the tools are already available, and only use sudo when not running as root - run the integration tests in the documentation container, and add a smoke test that runs the action there without installing anything Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014WUWh7MxCGbjgikbK3RwEv
The pip bundled with a fresh venv (24.0 on Python 3.11) rejects "project-documentation @ git+file://..." as an invalid requirement. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014WUWh7MxCGbjgikbK3RwEv
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.
Summary
Lets the action run inside the
embedded-devcontainer-documentationcontainer image, which already contains Pandoc and LaTeX. Consumers such as e-foc's releasebuild_documentationjob can then stop installing the tool chain on every run.Inside a container the action currently fails in two places:
sudo, so thesudo apt-get installstep fails.actions/setup-pythondoesn't support the image's Ubuntu release, sopip installinto the system Python fails.Changes
action.ymlpython-version: ""skipsactions/setup-pythonand uses thepython3on thePATH. The default stays3.11, so existing users are unaffected.$RUNNER_TEMP, which is added to thePATH. This works with a runner Python and with an externally managed system Python.pandoc,pdflatex,lmodern.styandtitlesec.styare already available. Otherwise it installs as before, usingsudoonly when not running as root.CI
Integration testsjob runs in the documentation container (pinnedv7.4.0@sha256:…) instead of installing Pandoc/LaTeX with apt.Action smoke test (documentation container)job runs the action in the container withpython-version: "". It produces the requirements PDF, the documentation PDFs and the traceability-matrix PDF without installing anything.Docs:
README.mdanddocs/usage.mddescribe the emptypython-versionand the container.Verification
In the published
gabrielfrasantos/embedded-devcontainer-documentation:v7.4.0image:kpsewhichreturns non-zero if any file is missing), and there is nosudo.validate-requirements,generate-requirements-pdf,build-pdfs(architecture, design, theory and requirements PDFs) and the traceability matrix plus itspdflatexPDF all succeed onexamples/e-foc.pytest tests/integration: 13 passed.Follow-up
After this is released, e-foc's release
build_documentationjob can run in the same container withpython-version: ""and drop its own TikZ/LaTeX install step.Generated by Claude Code