Skip to content

CI canonicalization: GitHub Actions, TagBot/CompatHelper/Dependabot, compat bounds, Runic formatting, typo fixes#37

Closed
ChrisRackauckas-Claude wants to merge 7 commits into
luchr:masterfrom
ChrisRackauckas-Claude:canonicalization-ci
Closed

CI canonicalization: GitHub Actions, TagBot/CompatHelper/Dependabot, compat bounds, Runic formatting, typo fixes#37
ChrisRackauckas-Claude wants to merge 7 commits into
luchr:masterfrom
ChrisRackauckas-Claude:canonicalization-ci

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown

This PR should be ignored until reviewed by @ChrisRackauckas.

This is the CI canonicalization promised in #35 (and it completes what #30 and #31 started). It builds on top of the merged JLL adoption (#36). It deliberately does not touch the memory-model items deferred in #35, and it does not change any solver code semantics.

What changed

CI / automation (.github/)

  • Tests.yml — test matrix on Linux/Windows/macOS with Julia 1, plus min (resolves to the 1.10 compat floor) and pre on Linux, via the public reusable workflow SciML/.github/.github/workflows/tests.yml@v1 (same pinning convention as SciML/Sundials.jl, which is the model binary-wrapper repo). Includes Codecov upload; without a CODECOV_TOKEN secret the upload step is best-effort and never fails CI.
  • Downgrade.yml — tests the declared compat lower bounds on Julia LTS (reusable workflow).
  • FormatCheck.yml — Runic format check (reusable workflow).
  • SpellCheck.ymltypos check (reusable workflow), configured by _typos.toml.
  • TagBot.yml / CompatHelper.yml — standard upstream templates (these only need the default GITHUB_TOKEN, so they work as-is outside the SciML org).
  • dependabot.yml — weekly GitHub Actions version updates.
  • Removed the dead .travis.yml and appveyor.yml.

The four reused workflows are public and callable cross-org, so this repo gets SciML's maintained CI logic without moving anywhere; nothing in them assumes SciML-org secrets.

Project.toml

  • Compat entries for all dependencies, including standard libraries, per the post-1.10 General registry requirements.
  • julia = "1.10" (LTS) floor: ODEInterface_jll = "0.0.2" (the JLL version current master loads) itself requires Julia ≥ 1.10, so 1.10 is the real floor.
  • Version left at 0.5.1 (unregistered; master already bumped it after Fix Julia 1.12 compatibility issue with ODEInterface_jll loading #36). Note for review: since this drops Julia < 1.10 support relative to registered 0.5.0, you may prefer releasing this as 0.6.0 instead — I left the number alone deliberately.

Formatting

  • Ran Runic.jl over all 56 Julia files (the bulk of the diff, as announced in Possibly migrate to SciML for maintenance? #35). Purely mechanical, AST-preserving.
  • The two ROBER example files contained Julia 0.x-era 10.^[...] syntax that is a parse error on every Julia 1.x — fixed to 10.0 .^ [...] (separate commit) so the files parse at all.

Typos

  • Fixed genuine typos in docstrings, Markdown docs, and comments (e.g. "informations" → "information", "licsense" → "license", "successfull" → "successful").
  • Untouched: LICENSE.md, every Fortran source file (*.f, *.f90), and all author attributions — _typos.toml excludes them from the check, and allowlists Fortran identifiers (contex, contro, implct, nd) and citation names (Stoer, Numer. Math.) so CI never "corrects" them. README/Project.toml attribution to @luchr is unchanged.

README

  • Replaced the dead Travis/AppVeyor/Coveralls badges with GitHub Actions + Codecov badges.

Local verification

Ran on this branch, both passing (Testing ODEInterface tests passed):

  • julia +1.10 (1.10.11): Pkg.build("ODEInterface"); Pkg.test() — all 11 test sets pass
  • julia +release (1.12.5): Pkg.build("ODEInterface"); Pkg.test() — all 11 test sets pass

Unmodified master was also tested on both versions first (green), so any CI failure surfaced here is attributable to this PR. All files pass runic --check, typos exits clean, and the workflows pass actionlint.

Notes / follow-ups

  • Codecov coverage upload will work better if a CODECOV_TOKEN repo secret is added (optional).
  • TagBot needs no setup; CompatHelper runs on a daily cron with the default token.
  • Dependabot auto-merge was intentionally not added (repo-owner policy decision).

Closes #30. Closes #31.

🤖 Generated with Claude Code

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
…Helper, Dependabot

Tests/Downgrade/FormatCheck/SpellCheck reuse the public SciML/.github
reusable workflows; TagBot and CompatHelper use the standard upstream
templates so they work with the default GITHUB_TOKEN outside the SciML org.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ODEInterface_jll 0.0.2 (the version with the Julia 1.12 loading fix layout)
itself requires Julia >= 1.10, so 1.10 LTS is the supported floor.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
`10.^[...]` is a parse error on all Julia 1.x versions; use `10.0 .^ [...]`.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Vendored Fortran sources, LICENSE.md, and generated example artifacts
(tex/ipynb/mw) are excluded from the typos check; Fortran identifiers
(contex, contro, implct, nd) and citation names (Stoer, Numer. Math.)
are allowlisted.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas-Claude

Copy link
Copy Markdown
Author

Closing in favor of splitting this into two focused PRs, as requested, to separate the CI/infrastructure pieces from the actual code changes:

#39 depends on #38 (its FormatCheck/SpellCheck checks enforce the standards applied in #38), so #38 should be merged first. Both are drafts and should be ignored until reviewed by @ChrisRackauckas.

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.

2 participants