diff --git a/README.md b/README.md index 833d0617..b195f640 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,12 @@ See [an example using jackdaw](https://github.com/FundingCircle/topology-grapher ## Releasing -Anyone with the appropriate credentials can "cut a release" of jackdaw using the following steps. +Anyone with the appropriate credentials can "cut a release" of jackdaw +* Tags are protected, you will need to be a maintainer or admin to apply them +* Clojars deployment uses a protected env, once a tag is created, the CI job to deploy will need to be reviewed by the clojars env owner + +Steps: 1. Review the diff of master vs the latest released tag (e.g. while preparing 0.7.0, I looked at https://github.com/FundingCircle/jackdaw/compare/0.6.9...master to see what was actually merged vs what was in the Changelog). Make a PR to put a date on the version being released and if necessary ensure completeness and consistency of the Changelog 2. Use the [Draft a new release](https://github.com/FundingCircle/jackdaw/releases/new) feature in github to prepare a release 3. In the "tag version" field, enter the proposed version @@ -42,6 +46,10 @@ Anyone with the appropriate credentials can "cut a release" of jackdaw using the Steps 2 to 6 is essentially `git tag $version -m "$title\n\n$description" && git push --tags` +#### Snapshot release + +Snapshot releases can be created by pushing a tag with the format `publish-snapshot*` + ## License Copyright © 2017 Funding Circle