Repository navigation
ci: publish generated manual editions as release assets - #256
Open
somethingwithproof wants to merge 1 commit into
Open
somethingwithproof wants to merge 1 commit into
somethingwithproof wants to merge 1 commit into
Conversation
Committing the PDF and text editions put a 39 MB PDF and nine text editions into every documentation change, and pinned links in the generated text meant even a one-line Markdown fix rewrote all of them. Build and verify the editions in CI as before, then upload them from a separate job, which runs no repository code, to the manuals-develop prerelease after each change to develop. Stop tracking the generated outputs and point the download pages at the release assets. The ReportIt PDFs stay committed because their editable source is not in this repository. Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
somethingwithproof
force-pushed
the
docs/manuals-release-assets
branch
from
November 19, 2026 10:18
b2c0817 to
67f1036
Compare
|
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.



Stacked on #248.
Every documentation change currently has to rebuild and commit the generated manuals. Generated text pins its links to the source commit, so even a one-line Markdown fix rewrites the 39 MB development PDF, eight companion PDFs and nine text editions. A two-line correction in #248 touched 20 files.
This PR keeps the existing build and verification and changes only where the results go:
PDF and text manual editionsstill builds and verifies every edition on each pull request and ondevelop.develop(or a manual run ondevelop), a separatepublishjob uploads the 21 verified outputs to a fixedmanuals-developprerelease, replacing the previous assets. That job hascontents: write, runs no repository code, and only downloads the verified artifact. The build job keeps its read-only token.resource/manuals/, plusresource/pdf/cacti-manual.pdfand its manifest, are removed from Git and ignored.Downloads.md,Other-Manuals.md,Development-and-Testing.mdand the publication guide now link to the release assets.Asset names are the current file names. The two manifests are renamed to
cacti-manual-manifest.jsonandeditions-manifest.jsonbecause release assets share a single namespace.The release links return 404 until the first publish runs after merge. Running the workflow once on
developfills them immediately. Mirroring the editions on files.cacti.net is still a separate maintainer step.Validation, run from a clean checkout of this branch:
verify_other_manuals.pyreportscomplete: true.