You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -168,6 +168,40 @@ A Pull Request can't be merged before all SonarCloud issues are being fixed!
168
168
#### Architecture and technologies
169
169
For all architecture and technology choices (for example frameworks, build tools, database choices, etcetera), please check the source code (duh!) and our [CoMPAS Architecture Github Pages](https://com-pas.github.io/compas-architecture/).
170
170
171
+
#### Github Packages
172
+
To make artifacts between the different GIT repositories available we are using Guthub Packages to ditribute these.
173
+
Every GIT repository can build its artifacts and publish these to Github Packages.
174
+
Other GIT repositories can then add Github Packages as Maven repository to their build tool.
175
+
See below how to do both action for the specific tools.
176
+
177
+
To use Github Packages a username and token is needed. The username is your Github username. The token can be genreate in Github by going to your settings, Developer settings, Personal access tokens.
178
+
Generate a new token here and make sure that the scope "read:packages" is enabled. Use this token below to configure the build tools.
179
+
180
+
#### Basic Gradle
181
+
The project uses Gradle to manage the build. Most projects use multi-module structures to build all code. A basic command to run gradle is:
182
+
```
183
+
$ gradle build
184
+
```
185
+
#### Github Packages in Gradle
186
+
To use Github Packages in Gradle an extra repository need to be added to the build process.
Because credentials are needed for Github Packages these can be passed in 2 different ways.
202
+
- First solution is to added the properties "githubUsername" and "githubToken" to your gradle.properties in your home directory (~/.gradle/gradle.properties). This solution doesn't seem to work with Intellij IDEA.
203
+
- The second solution is to create two environment properties "GITHUB_USERNAME" and "GITHUB_TOKEN". This ones is also used by Github Actions.
204
+
171
205
#### Basic Maven Usage
172
206
The project uses maven to manage the build. The configuration of all the tools is fairly standard, so if you have already contributed to Java projects, you should feel right at home. You can safely run the full test suite, checkstyle, see code coverage information and the generated documentation with the following command:
0 commit comments