ci: FormatCheck gate + enable VersionCheck/Documentation w/ PR previews - #27
Closed
sotashimozono wants to merge 1 commit into
Closed
ci: FormatCheck gate + enable VersionCheck/Documentation w/ PR previews#27sotashimozono wants to merge 1 commit into
sotashimozono wants to merge 1 commit into
Conversation
Bring ParallelManager's CI up to the infra standard (matches Pinax/DataVault):
- FormatFix (auto-fix) -> FormatCheck (hard gate): JuliaFormatter v2,
format(".", overwrite=false), exit 1 on dirty.
- Enable VersionCheck.yml: every PR to main must bump Project.toml version.
- Enable Documentation.yml + push_preview PR previews; add CleanupPreview.yml
to prune previews/PR#<n> on PR close.
- Fix the docs build (the reason Documentation was disabled):
- checkdocs=:exports so the documented internal _run_* helpers don't need
manual @docs entries (they are not part of the public API).
- api.md: add the 4 exported-but-undocumented symbols (run_loop!,
verify_workers!, merge_and_save_manifest!, merge_event_logs) + the
top-level module docstring.
- Manifest.jl: drop a `(@extref)` link (no DocumenterInterLinks loaded) to
a plain code span, fixing the "invalid local link" cross-reference error.
- gitignore the build-time downloaded docs assets (favicon.ico, logo.png).
- Bump 0.4.0 -> 0.4.1 (VersionCheck runs on its own introducing PR, mirroring
Pinax's "enable VersionCheck + bump" commit).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
📚 Docs preview: https://sotashimozono.github.io/ParallelManager.jl/previews/PR27/ (updates on each push to this PR) |
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
sotashimozono
added a commit
that referenced
this pull request
Jun 26, 2026
… + previews Consolidates the CI hardening (PR #27) into the registration PR so 0.4.1 is one release: drop [sources] + AutoRegister + CI standardization together.
Member
Author
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.
What
Brings ParallelManager's CI up to the infra standard (matching Pinax / DataVault), as one batch:
FormatFix(auto-commits fixes)FormatCheck— hard gate (format(".", overwrite=false), exit 1 on dirty, JuliaFormatter v2)mainmust bumpProject.tomlversionpush_previewPR previews;CleanupPreview.ymlprunespreviews/PR#<n>on PR closeWhy Documentation was disabled — and the fix
The docs build failed (3 errors), so the workflow had been parked as
.disabled. Fixed here:checkdocs=:exports— the internal_run_pmap!/_run_sequential!/_run_one_with_lock!/_run_one_with_retry!helpers carry docstrings (good for source readers) but are not public API, so they shouldn't be required in the manual.:exportsscopes the missing-docs check to exported symbols.api.md:run_loop!,verify_workers!,merge_and_save_manifest!,merge_event_logs— plus the top-level module docstring.Manifest.jl:[ParamIO.canonical](@extref)→ plain code span.@extrefneedsDocumenterInterLinks(not loaded), which surfaced as an "invalid local link" cross-reference error. Not worth wiring a cross-package inventory just to enable the build.Docs now build green locally (
julia --project=docs docs/make.jl→ exit 0; only the expected "skipping deployment" notice off-CI).Also
.gitignorethe build-time downloaded docs assets (favicon.ico,logo.png— fetched bymake.jlat build;custom.cssstays tracked).0.4.0 → 0.4.1. VersionCheck runs on its own introducing PR (forpull_request, GitHub uses the PR branch's workflow files), so the enabling PR must itself bump — mirroring Pinax'sci: enable VersionCheck workflow + bump version to 0.1.1commit.chore/drop-sources-register, which drops[sources]+ enables AutoRegister). Both branch offmain, so whichever merges second needs a trivial rebase + re-bump — VersionCheck enforces this automatically. Suggested order: this CI PR first (no registration side-effects; AutoRegister stays.disabledhere), then chore: General registration prep + CI standardization (0.4.1) #26 (rebases to 0.4.2, drops[sources], enables + triggers AutoRegister).🤖 Generated with Claude Code