Skip to content

Panzer1119/codemakers4j

Repository files navigation

codemakers4j

Publish Package to GitHub and create a Release

Quality Gate Status

Bugs

Vulnerabilities

Code Smells

Duplicated Lines (%)

Lines of Code

Codemakers 4 Java Library

Developer Guide

Make sure you have set up your local Git Hooks:

git config core.hooksPath .githooks

This will make sure your commit messages follow the Conventional Commits Specification.

Here's some handy commands:

Command Usage
gradle test Run the tests.
gradle build Run the builds.
gradle shadowJar Create the Uber Jar with all Dependencies.

Semantic Versioning

This project uses standard-release to update the version in the build.gradle file from the changes in the history and to create the CHANGELOG.md file.

Any time you want to cut a new release, run:

npx dwmkerr/standard-version --sign

This will:

  • Update the CHANGELOG.md
  • Update the version number based on the commit history
  • Create a git tag with the new version number

Finally, just push the tag to trigger a deployment of the new version:

git push --follow-tags