lobsterdore/release-dash repository overview

⁠Release Dash

Please see https://github.com/lobsterdore/release-dash⁠ for full details.

⁠What it does

Designed for pipelines that have multiple environments with manual gates, developers can check the dashboard to see what will go out when a release is pushed from one environment to another.

The dashboard requires a Github PAT to run, any repo that the PAT has read access to will be inspected, if a .releasedash.yml file is found in the root of the repo then it will appear on the board. For each repo a list of tags is supplied via the .releasedash.yml config file, these tags are diffed to produce a changelog.

⁠How to run

# Assuming direnv is installed
echo "export GITHUB_PAT=\"[PAT]\"" > .envrc
direnv allow
# See https://hub.docker.com/r/lobsterdore/release-dash for versions
docker run -dit -e GITHUB_PAT -p 8080:8080 lobsterdore/release-dash:[VERSION]

⁠Configuration

For a full list of available environment vars see config/configuration.go⁠.

Some key env vars are:

• GITHUB_CHANGELOG_FETCH_TIMER_SECONDS (default 60) controls the interval for grabbing the changelog for each repository that should appear on the dashboard
• GITHUB_PAT the Github Personal Access Token used to read repos
• GITHUB_REPO_FETCH_TIMER_SECONDS (default 600) controls the interval for looking up repos that should appear on the dashboard
• LOGGING_LEVEL (default error) verbosity of logs, set to debug to see detailed info on each repo read by the dash