Skip to content

Latest commit

 

History

History
28 lines (26 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

28 lines (26 loc) · 1.35 KB

Contributing

Several scripts in the project root are to aid in contributing.

  • build-as-ci-does.sh — Recreate locally the build used by CI in GitHub actions using Batect and Earthly (both use Docker):
    • Run a clean full build for Gradle
    • Run the Gradle-built demo program
    • Run a clean full build for Maven
    • Run the Maven-built demo program Helpful when CI has steps that local developers do not, and you want to reproduce or explore locally a CI problem. The script should match the actions your CI takes on pushes (this project uses GitHub actions)
  • compare-tooling-versions.sh — If your project supports both Gradle and Maven builds (unlikely), a quick way to look at dependency and plugin versions between the two
  • coverage Checks if the local code passes at given levels of code coverage. The script is focused on Maven, but with edits would do the same for Gradle. This supports the "ratchet" pattern.
  • run-with-gradle.sh If you are a Gradle project, you will likely rename this to just run or similar
  • run-with-maven.sh If you are a Maven project, you will likely rename this to just run or similar