Skip to content

Commit 0de9578

Browse files
authored
add a guide on how to configure the GitHub Gradle Packages registry (#30)
1 parent d40ecbd commit 0de9578

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,10 +208,27 @@ To build the project, the following prerequisites must be met:
208208
209209
### Setup
210210
211-
To get started, call:
211+
To get started, you first need to configure the GitHub Maven Package registry to be able to pull the [AbouBits Java Checkstyle Config](https://github.com/aboutbits/java-checkstyle-config) from the GitHub Gradle registry.
212+
213+
Follow https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry
214+
The guide basically tells you to click on `Generate new token (classic)` on https://github.com/settings/tokens, add the permission `read:packages` and copy the token which we need below.
215+
216+
If it does not exist yet, create a file `~/.gradle/gradle.properties` in your home directory and add the following lines.
217+
218+
```properties
219+
gpr.user=<your_github_user>
220+
# The token generated above
221+
gpr.key=<your_github_token>
222+
```
223+
224+
Then call:
212225

213226
```bash
214227
make init
228+
229+
# or
230+
231+
../gradlew :operator:quarkusBuild
215232
```
216233

217234
### Development

0 commit comments

Comments
 (0)