diff --git a/build_docs/building.adoc b/build_docs/building.adoc index 0d195935..d2185d12 100644 --- a/build_docs/building.adoc +++ b/build_docs/building.adoc @@ -4,7 +4,11 @@ - mvn - OpenShift Client (or kubernetes) -= Building and Devloping += GitHub Packages Setup + +This project uses GitHub packages for of its dependencies. Before you can build this project using `mvn install` you must configure Maven to authenticate to GitHub with a Personal Access Token that has packages:read permission. Please refer to [link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry[GitHub's documentation] fordetailed instructions. + += Building and Developing The operator is written in Java as a multi module Maven project. The easiest way to build and run the operator locally is @@ -24,4 +28,4 @@ link:https://github.com/bf2fc6cc711aee1a0c2a/operator/tree/main/olm/olm-template == Operator Container Build -The Operator container is built by link:https://quarkus.io/guides/container-image[Quarkus JIB]. The configuration is provided by link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/source/rhoas/src/main/resources/application.properties[application.properties]. The link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/.github/workflows/release.yml#L32[GitHub action release workflow] contains an example of these values being overidden to release the operator. \ No newline at end of file +The Operator container is built by link:https://quarkus.io/guides/container-image[Quarkus JIB]. The configuration is provided by link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/source/rhoas/src/main/resources/application.properties[application.properties]. The link:https://github.com/bf2fc6cc711aee1a0c2a/operator/blob/main/.github/workflows/release.yml#L32[GitHub action release workflow] contains an example of these values being overidden to release the operator.