Update README.md #261
Update README.md #261
Conversation
Updated readme as the instructions were missing details about enabling github app authentication when installing the helm chart instead of manually applying it. Added more detailed instructions for the manual method.
Added additional comment about tokenRef, increased visibility of replacing the org name in two places (maybe this should just be one instead of two?) Removed maven example, as that was preventing the pod from being scheduled at all. example included no sample settings.xml so the example is incomplete. This way, the example will run first time without errors.
removed trailing colons
| @@ -45,14 +47,6 @@ Create a secret called `github-runner-app` by executing the following command in | |||
| kubectl create secret generic github-runner-app --from-literal=GITHUB_APP_INTEGRATION_ID=<app_id> --from-file=GITHUB_APP_PRIVATE_KEY=<private_key> | |||
| ``` | |||
|
|
|||
| Finally define the following on the operator deployment: | |||
There was a problem hiding this comment.
I don't think this should be removed as it's describing how it actually works (although helm abstracts that)
There was a problem hiding this comment.
This value is already set in the deployment.yaml if you were to download it manually and apply it.
For the approach mentioned in this section of the readme, this value both doesn't need to be set and cannot be set, without downloading the helm chart and deploying it manually.
There was a problem hiding this comment.
When trying to follow these instructions, I got held up by not being able to find how or where to define that secretRef. I then found that it didn't need to be set at all, so for clarity, it should not be in the readme
There was a problem hiding this comment.
@davidkarlsen, what should happen to resolve this code review so it can get merged into main?
Updated readme as the instructions were missing details about enabling github app authentication when installing the helm chart instead of manually applying it.
Added more detailed instructions for the manual method.