Skip to content

Commit 327eef5

Browse files
Clean up release doc, and standardize process (#493)
1 parent cc49236 commit 327eef5

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

RELEASE.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@ This project is hosted on [Clojars][clojars]. You can see it [here][release-sit
44

55
Releasing the project requires these steps:
66

7-
0. Set the version number in the project.clj file.
8-
1. Run ```lein do clean, test``` to ensure everything is working as expected.
9-
2. Use a GitHub [project release][github-release-url] to release the project and tag (be sure it follows [semver][semantic-versioning])
10-
3. Run ```lein deploy clojars``` to deploy the project to the Clojars repository.
11-
4. Update `main` to a new minor version
7+
0. Assert all tests are passing and the project builds : `lein do clean, test`
8+
1. Make sure CHANGELOG.md is up-to-date for the upcoming release.
9+
2. Assert you have Github setup with [gpg](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)
10+
3. Add gpg key to [sign](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) your commits
11+
* GPG will likely require an additional export to spawn an interactive prompt for signing:
12+
```export GPG_TTY=$(tty)```
13+
4. Create a [Clojars][clojars] Account and [Deploy Token](https://github.com/clojars/clojars-web/wiki/Deploy-Tokens) if you do not already have one.
14+
5. Create a lein [credentials](https://leiningen.org/deploy.html#gpg) file using the account and token above.
15+
6. Run `lein release <release-type>`, where release-type is one of `:patch`,`:minor` and `:major`
16+
7. Push the new main branch to the repo.
17+
8. Push the new tag to the repo.
1218

1319
[clojars]: https://clojars.org
1420
[release-site]: https://clojars.org/com.cerner/clara-rules
15-
[project-url]: https://github.com/cerner/clara-rules/
16-
[semantic-versioning]: http://semver.org/
17-
[github-release-url]: https://help.github.com/articles/creating-releases/
21+

0 commit comments

Comments
 (0)