Skip to content

Commit

Permalink
docs: add section on submodules and token
Browse files Browse the repository at this point in the history
  • Loading branch information
jenspots committed Nov 20, 2024
1 parent c128114 commit 5373ee3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ brew install rdf-connect/orchestrator https://github.com/rdf-connect/orchestrato

## Contributors

### Submodules

The Protobuf declarations are available in a seperate repository. Make sure to initialize it's respective submodule, since otherwise your Gradle build will fail.

```shell
git submodule update --init --recursive
```

You can of course also use the `--recurse-submodules` switch with `git clone`.

### Github Authentication

Some of the pipelines found in this repository depend on repositories hosted on GitHub, requiring an authentication token. These can be configured using the environment variables listed in `.env.example`. It suffices to copy this file to `.env` and fill in the variables.

### Publishing

This project automatically publishes Maven packages and a Docker image whenever the `projectVersion` field in [`gradle.properties`](./gradle.properties) is updated.
Expand Down

0 comments on commit 5373ee3

Please sign in to comment.