Skip to content

ci/quality checks#96

Open
caverac wants to merge 2 commits intoCategoricalData:masterfrom
caverac:ci/quality-checks
Open

ci/quality checks#96
caverac wants to merge 2 commits intoCategoricalData:masterfrom
caverac:ci/quality-checks

Conversation

@caverac
Copy link

@caverac caverac commented Mar 12, 2026

Introduces a Gradle-based build system, code quality tooling, and a GitHub Actions CI pipeline to the project

Changes can be organized in two buckets

Code quality

These tools are introduced to the project

  1. Linting: Checkstyle 10.21
  2. Formatting: Spotless
  3. Testing: JUnit 5

And configured to be lenient, over time they can tightened to ensure code quality in the project, and to catch potential regressions when new features are introduced.

Automation

  1. Github workflows
  2. Pre-commit hooks

These run automatic tests on code quality on PRs

How to use

Command Purpose
./gradlew compileJava compile
./gradlew test run tests
./gradlew jacocoTestReport generate coverage report
./gradlew checkstyleMain run checkstyle
./gradlew spotbugsMain run spotbugs
./gradlew spotlessCheck check formatting
./gradlew spotlessApply auto-fix formatting

@@ -0,0 +1,78 @@
name: CI
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/CategoricalData/CQL/actions/runs/23004104156

This is a chicken-and-egg problem: the CI workflow itself is part of this PR, so it can't run until it's merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant