FundingCircle / jackdaw

A Clojure library for the Apache Kafka distributed streaming platform.
https://fundingcircle.github.io/jackdaw/
BSD 3-Clause "New" or "Revised" License
369 stars 80 forks source link

Add documentation for cutting releases of jackdaw #219

Closed cddr closed 4 years ago

cddr commented 4 years ago

Now that the release script is working properly, the instructions for cutting a release are quite simple. This PR adds them to the README.

codecov[bot] commented 4 years ago

Codecov Report

Merging #219 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #219   +/-   ##
=======================================
  Coverage   79.97%   79.97%           
=======================================
  Files          42       42           
  Lines        2597     2597           
  Branches      150      150           
=======================================
  Hits         2077     2077           
  Misses        370      370           
  Partials      150      150

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f278f73...478678d. Read the comment docs.

AndreaCrotti commented 4 years ago

Looks good, we could mention also that it's really the same as just doing a git tag $version and git push --tags locally but apart from that it's fine