Skip to content

Commit c115f9c

Browse files
docs: add release instructions
1 parent 828d064 commit c115f9c

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,32 @@ The command will print a Graphviz directed graph DSL.
160160
1. Copy the DSL and paste it into the [online Graphviz tool](https://dreampuf.github.io/GraphvizOnline).
161161
2. The tool selects the **dot** engine by default, for best results use the **circo** engine from the engine dropdown.
162162

163+
## Release a new build
164+
165+
### Credentials (initial setup)
166+
167+
1. Create a `~/.jreleaser/config.properties` file.
168+
2. Add the following properties to the file.
169+
170+
```text
171+
JRELEASER_GITHUB_TOKEN=<token>
172+
JRELEASER_HOMEBREW_GITLAB_TOKEN=<token>
173+
```
174+
175+
Where `token` is a GitHub personal access token with `delete:packages`, `repo`, and `write:packages` scopes.
176+
177+
### Releasing
178+
179+
1. If you have multiple JDKs installed, switch to JDK 11.
180+
181+
2. Release,
182+
- For minor releases, run `./release.sh`
183+
- For bug fix releases, run `./bug_fix_release.sh`
184+
185+
3. Update changelog
186+
- Go to the GitHub [releases](https://github.com/LegacyCodeHQ/eureka/releases) page and edit the release notes for
187+
the latest release.
188+
163189
## Licenses
164190

165191
```

0 commit comments

Comments
 (0)