Skip to content

Add CI/CD workflows and rewrite README - #1

Merged
halotukozak merged 3 commits into
mainfrom
fix-readme-and-ci
Jun 15, 2026
Merged

Add CI/CD workflows and rewrite README#1
halotukozak merged 3 commits into
mainfrom
fix-readme-and-ci

Conversation

@halotukozak

Copy link
Copy Markdown
Owner

Ports CI/CD and documentation setup from halotukozak/made and rewrites the README in the same style.

Workflows

  • ci.yml — split into a lint job (scala-cli fmt --check) and a test job that runs tests with Scala 3 native coverage (-coverage-out, excluding test/), generates the report, uploads to Codecov, and checks scala-cli doc.
  • publish.yml (new) — publishes to Maven Central on v* tags (Sonatype + PGP).
  • docs.yaml (new) — deploys scaladoc to GitHub Pages on main / tags; links point at halotukozak/mcodec.

Coverage

  • .scoverage/report.sc (new) — generates HTML + Cobertura reports from scoverage measurements.

Misc

  • .gitignore — keep .scoverage/report.sc, ignore scala-doc and measurement output.
  • README.md — GenCodec-style overview, install (scala-cli/sbt/mill), quickstart, acknowledgements.

Required setup before workflows are fully green

  • Secrets: CODECOV_TOKEN, SONATYPE_USERNAME, SONATYPE_PASSWORD, PGP_PRIVATE_KEY, PGP_PASSPHRASE.
  • Settings → Pages → source: GitHub Actions.

🤖 Generated with Claude Code

halotukozak and others added 3 commits June 15, 2026 19:11
- ci.yml: split into scalafmt lint + test job with Scala 3 coverage,
  Codecov upload, and doc check
- publish.yml: publish to Maven Central on v* tags
- docs.yaml: deploy scaladoc to GitHub Pages
- .scoverage/report.sc: coverage report generator (HTML + Cobertura)
- .gitignore: keep report.sc, ignore scala-doc and measurement output
- README: GenCodec-style overview, install, quickstart, acknowledgements

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@halotukozak
halotukozak merged commit 4f4ece4 into main Jun 15, 2026
2 checks passed
@halotukozak
halotukozak deleted the fix-readme-and-ci branch June 15, 2026 17:58
@codecov

codecov Bot commented Jun 15, 2026

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

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