status-reporter/README.md

55 lines
1.2 KiB
Markdown

# status-reporter
`status-reporter` is a controller that watches tekton `PipelineRuns` for status cahnges.
These are synced to the associated git commit hashes.
For successful runs a preview environment comment will be added to the pull request.
The controller is supposed to be running as a single instance, because it maintains a memory-local cache.
`PipelineRun` requirements:
Params:
* gitapi - `github`, `ghe` or `gitea`
* issue - pull request issue id
* scheme - `http://` or `https://`
* tektonurl - `http://tekton-dashboard.example.com`
* previewurl - `my-preview-env.example.com`
Resources:
* git - revision: git commit hash, url: `https://github.com/example/repo.git`
# Requirements
* Kubernetes Cluster
* go
* ko
# Build and run
Create git authentication secret:
**NOTE:** the name must be `git-auth`.
```
cat <<EOF>secret.yaml
apiVersion: v1
kind: Secret
metadata:
name: git-auth
namespace: status-reporter
type: Opaque
stringData:
github.com: "<username>:<password>"
github.com_foo: "<foo username>:<foo password>"
github.com_foo_bar: "<bar username>:<bar password>"
EOF
```
```
echo KO_DOCKER_REPO='gcr.io/my-gcloud-project-name' >env.txt
./build.sh
```