Skip to content

Add testing, CI/CD, coverage, docs & license#7

Merged
rafabench merged 2 commits intomasterfrom
update-julia-1.11
Mar 12, 2026
Merged

Add testing, CI/CD, coverage, docs & license#7
rafabench merged 2 commits intomasterfrom
update-julia-1.11

Conversation

@rafabench
Copy link
Copy Markdown
Owner

Summary

  • License: Added MIT license (PSR / rafabench, 2024-2026)
  • Tests: Comprehensive test suite with 121 tests across 11 testsets covering all exported functions, edge cases (identical models, tolerance effects), integration tests, and output formatting — runs via Pkg.test()
  • CI/CD: GitHub Actions workflow with Julia 1.11 + nightly on ubuntu/windows/macos, Codecov coverage integration, and Documenter.jl doc deployment
  • Documentation: Documenter.jl setup with API reference (@docs blocks for all exported items) and usage guide
  • Docstrings: Added to all exported functions and structs
  • Exports fix: Replaced stale read_from_file export with readmodel; exported all public structs (VariablesDiff, BoundsDiff, etc.)
  • README: Added CI/coverage/docs badges; fixed usage example to use positional args

Test plan

  • julia --project=. -e 'using Pkg; Pkg.test()' — all 121 tests pass locally
  • CI workflow runs green on all matrix entries (ubuntu/windows/macos x Julia 1.11/nightly)
  • Coverage report appears on Codecov (requires CODECOV_TOKEN secret)
  • Docs deploy to gh-pages (requires GitHub Pages settings)

🤖 Generated with Claude Code

rafabench and others added 2 commits March 11, 2026 21:47
- Add MIT license
- Create comprehensive test suite (121 tests) using Test stdlib with Pkg.test() support
- Add GitHub Actions CI workflow (Julia 1.11 + nightly, ubuntu/windows/macos, coverage via Codecov)
- Set up Documenter.jl with API reference and usage docs
- Add docstrings to all exported functions and structs
- Fix stale read_from_file export to readmodel, export all public structs
- Add CI/coverage/docs badges to README, fix usage example to use positional args
- Update .gitignore for docs build artifacts

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@rafabench rafabench merged commit be3cc17 into master Mar 12, 2026
7 checks passed
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