From c115f9c9752e862f97926a34b7a0437b96977b1a Mon Sep 17 00:00:00 2001 From: Ragunath Jawahar Date: Fri, 1 Dec 2023 13:46:42 +0530 Subject: [PATCH] docs: add release instructions --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index cb64ece..cca892a 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,32 @@ The command will print a Graphviz directed graph DSL. 1. Copy the DSL and paste it into the [online Graphviz tool](https://dreampuf.github.io/GraphvizOnline). 2. The tool selects the **dot** engine by default, for best results use the **circo** engine from the engine dropdown. +## Release a new build + +### Credentials (initial setup) + +1. Create a `~/.jreleaser/config.properties` file. +2. Add the following properties to the file. + +```text +JRELEASER_GITHUB_TOKEN= +JRELEASER_HOMEBREW_GITLAB_TOKEN= +``` + +Where `token` is a GitHub personal access token with `delete:packages`, `repo`, and `write:packages` scopes. + +### Releasing + +1. If you have multiple JDKs installed, switch to JDK 11. + +2. Release, + - For minor releases, run `./release.sh` + - For bug fix releases, run `./bug_fix_release.sh` + +3. Update changelog + - Go to the GitHub [releases](https://github.com/LegacyCodeHQ/eureka/releases) page and edit the release notes for + the latest release. + ## Licenses ```