Repository navigation
Publish versioned API docs on GitHub Pages - #4
Merged
Merged
Conversation
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
Publish unified jtest API documentation directly on GitHub Pages. The site root redirects to the newest listed version, currently
/0.2.0/. Older releases remain available directly at/0.1.0/and future/<version>/paths. The root redirect preserves query strings and API symbol links.Generate assertions, suites, and the shared Python/Ruby runner API together in one Jo doc compiler pass, using the release's
README.mdas the API home page. Package onejtest-docs-vVERSION.zipwith a SHA-512 checksum per release. The Pages builder downloads and verifies each version listed indocs/api-versions.jsonland produces the root redirect plus version directories using Python's standard library.Update
RELEASE.mdwith unified doc generation, packaging, upload, historical backfill, and Pages publication commands. CI checks the API archive, and the Docs workflow validates PRs and deploys changes merged tomain.Initial setup is complete: unified API archives and checksums were generated from published tags
v0.1.0andv0.2.0, with their original READMEs, and added as new release assets. GitHub Pages is configured to use Actions with the custom domainjtest.jo-lang.org. Merging this PR deploys to https://jtest.jo-lang.org/.Check list
CHANGELOG.mdValidation:
git diff --checkpassed.Local validation used Jo 0.14.0, Python 3.10.12, and Ruby 3.0.2. Historical 0.1.0 docs used Jo 0.13.11; CI targets Python 3.12 and Ruby 3.3.
Compatibility
Public API signatures, package versions, and runtime requirements are unchanged. Published API docs remain snapshots of their release sources. New versions are appended to the manifest after their unified archive and checksum are uploaded; prior entries are retained to preserve direct version URLs. The website build uses Python's standard library.