Repository navigation
Refresh the README: metrics, flags, webhook events and Docker usage - #299
Merged
Merged
Conversation
- document the workflow metrics and the flags/env vars - webhook events are Workflow jobs and Workflow runs, not Check Run - mention the separate ingress/metrics ports - fix the Docker image name and tag, use go install, mention the Helm chart - use relative links and main instead of master Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Carlos Panato <ctadeu@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs cleanup found while reviewing the repo:
Check Run); explain the separate ingress (:8065) and metrics (:9101) listeners.ghcr.io/cpanato/github_actions_exporter:<version>(the old-linux-amd64name and v0.2.0 tag are stale) and publish the webhook port too.go get -u→go install ...@latest; mention the Helm chart.maininstead ofmaster(README links were broken, same in CONTRIBUTING.md).Not included: the chart's pinned image tag/digest (
v0.8.0) needs a chart version bump and a digest, so it is better handled with the next release.