Skip to content

ci: FormatCheck gate + enable VersionCheck/Documentation w/ PR previews - #27

Closed
sotashimozono wants to merge 1 commit into
mainfrom
ci/enable-checks
Closed

ci: FormatCheck gate + enable VersionCheck/Documentation w/ PR previews#27
sotashimozono wants to merge 1 commit into
mainfrom
ci/enable-checks

Conversation

@sotashimozono

Copy link
Copy Markdown
Member

What

Brings ParallelManager's CI up to the infra standard (matching Pinax / DataVault), as one batch:

Change Before After
Format FormatFix (auto-commits fixes) FormatCheck — hard gate (format(".", overwrite=false), exit 1 on dirty, JuliaFormatter v2)
VersionCheck disabled enabled — every PR to main must bump Project.toml version
Documentation disabled (docs didn't build) enabled + push_preview PR previews; CleanupPreview.yml prunes previews/PR#<n> on PR close

Why Documentation was disabled — and the fix

The docs build failed (3 errors), so the workflow had been parked as .disabled. Fixed here:

  1. 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. :exports scopes the missing-docs check to exported symbols.
  2. Added the 4 exported-but-undocumented symbols to api.md: run_loop!, verify_workers!, merge_and_save_manifest!, merge_event_logs — plus the top-level module docstring.
  3. Manifest.jl: [ParamIO.canonical](@extref) → plain code span. @extref needs DocumenterInterLinks (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

  • .gitignore the build-time downloaded docs assets (favicon.ico, logo.png — fetched by make.jl at build; custom.css stays tracked).
  • Bump 0.4.0 → 0.4.1. VersionCheck runs on its own introducing PR (for pull_request, GitHub uses the PR branch's workflow files), so the enabling PR must itself bump — mirroring Pinax's ci: enable VersionCheck workflow + bump version to 0.1.1 commit.

⚠️ Do not merge yet / coordination

🤖 Generated with Claude Code

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>
@github-actions

Copy link
Copy Markdown
Contributor

📚 Docs preview: https://sotashimozono.github.io/ParallelManager.jl/previews/PR27/

(updates on each push to this PR)

@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/Manifest.jl 0.00% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.
@sotashimozono

Copy link
Copy Markdown
Member Author

Integrated into #26 (chore/drop-sources-register) per request — both targeted 0.4.1, so they're now one release: drop [sources] + enable AutoRegister + CI standardization (FormatCheck / VersionCheck / Documentation + previews) together. Closing this in favor of #26.

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.

1 participant