Skip to content

Stack8/espresso

Repository files navigation

espresso - ZIRO's Java Utility Library

espresso is a library containing utilities meant to support all other java projects at ZIRO.

Development:

Create your feature branch and start working. To test how the changes you are making will work with another project, run:

./gradlew build && ./gradlew publish

This will publish a snapshot of the library to our internal Maven repository at https://repository.goziro.com/ with the name <version>-SNAPSHOT

You can then go to the other project, and change the version that project consumes to match your snapshot.

Testing:

Run the unit tests with: ./gradlew test

Publishing Your Changes

Other projects SHOULD NOT be consuming snapshots (aside from locally during development). Instead, they should only consume proper releases. Publishing and tagging releases is handled by Jenkins. When you merge your changes to main, it triggers a Jenkins job which builds and tests the repo, then attempts to tag the appropriate commit and publish a release. This versioning is managed by ./version.txt. YOU MUST BUMP THE VERSION WHEN MAKING CODE CHANGES. Please follow semantic versioning

Release Notes

Once you merge your changes, CI will publish a new version to Nexus and tag the repo. The last thing to do is to go to:

https://github.com/Stack8/espresso/releases

And publish a new release. Click draft a new release, and select your tag, the previous tag, and click generate release notes. Make sure "Set as the latest release" is selected, and publish your release. Now you're good to go!

About

Another Java Utility Library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

Languages