Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.16 KB

How to contribute and publish to maven

Contributing

  • Fork the repository
  • Create your own feature branch based off main
  • Raise a pull request
  • You can test your changes locally by using the following command
    sbt publishLocal

Publishing to maven

Guardian doc on publishing to maven and sonatype

Merge the pull request before publishing to maven and then publish from the main branch.

You can find useful notes on releasing to maven here

You can find useful notes on configuring sbt to publish to maven here

  • Execute the release command in sbt this will automate updating the version number and publish to maven central
   sbt release
  • Wait for up to two hours for it to appear
  • Test the release using a real project which has the library as a dependency (you can do this using sbt publishLocal)
  • Create a release on github to document the changes within the release