GitHub Action that creates a deployment overview page

This action uses the GitHub API to read various information from the repositories and creates a deployment overview page. The page is exported as JSON and Markdown. The markdown file can be published as .github/profile/README.md, because this page is display on the organization main page. The following information is collected:

• The latest release and a list of last releases for each repository
• The commits that have been done since the last release, this is basically the upcoming changelog once the release is done
• The pull requests that are open
• The latest release that have been deployed to the various environments.
• The actions that are waiting for an approval.

This action brings a default template default.md that can be used as a starting point. If the template is not specified, this default one is used. It can be copied and modified to fit the needs of the organization.

Sample output

Repository	Commits	PRs	Latest Release	dev	staging	prod
yasm-backend	🟥 1	🟨 1	1.13.1	🟥 e6e2948	🟩 1.13.1	🟩 1.13.1
yasm-frontend	🟥 11	🟨 2	1.13.5	🟥 4aa310d	🟩 1.13.5	🟩 1.13.5
yasmctl	🟩 0	🟩 0	1.13.3	🟩 1.13.3	🟩 1.13.3	🟩 1.13.3
yasm-proxy-odbc	🟩 0	🟩 0	1.10.0	🟩 1.10.0	🟩 1.10.0	🟩 1.10.0
yasm-integration	🟩 0	🟨 1	1.13.5	🟩 1.13.5	🟩 1.13.5	🟩 1.13.5
yasm-geocoding	🟥 2	🟩 0	1.3.0	🟥 ec76731	🟩 1.3.0	🟩 1.3.0
yasm-data	🟩 0	🟩 0	1.9.0	🟩 1.9.0	🟩 1.9.0	🟩 1.9.0
yasm-gotenberg	🟩 0	🟩 0	8.2.0-3	🟩 8.2.0-3	🟩 8.2.0-3	🟩 8.2.0-3

See EXAMPLE.md for a full example.

Requirements:

• A GitHub repository or a GitHub organization
• A GitHub Personal Access Token (PAT), see below
• If using multiple repositories (that is what this action is designed for), the environments of the repositories should be the same like "dev", "staging" and "production".

Use as GitHub Action

Example on using this action in a workflow:

name: Create Overview

on:
  workflow_dispatch:
  # Every day at 07:00
  schedule:
    - cron: '0 7 * * *'

jobs:
  create-overview:
    runs-on: ubuntu-latest
    steps:
      # Checkout the existing content of thre repository
      - name: Checkout
        uses: actions/checkout@v2

      # Create directory profile if it does not exist
      - name: Create profile directory
        run: mkdir -p profile

      # Run the deployment overview action
      - name: Deployment overview
        uses: prodyna/[email protected]
        with:
          # The organization to query
          organization: prodyna-yasm
          # A comma separated list of repositories to query
          repositories: yasm-backend,yasm-frontend,yasmctl,yasm-proxy-odbc,yasm-integration,yasm-geocoding,yasm-data,yasm-gotenberg
          # The comma separated list of environments that every repository should have
          environments: dev,staging,prod
          # A comma separated list of links to the environments
          environment-links: https://dev-yasm.prodyna.com,https://staging-yasm.prodyna.com,https://yasm.prodyna.com
          # 0=info, 1=debug
          verbose: 1
          # The GitHub Personal Access Token (PAT)
          github-token: ${{ secrets.OVERVIEW_GITHUB_TOKEN }}
          # The title for the status page
          title: "YASM Deployment Overview"
          # The target json file that is written
          target-json-File: profile/deployment-overview.json
          # The target md file that is written
          target-md-ile: profile/README.md
          # template-file: set only if you have an own one, otherwise remove this entry to take the default one
          template-file: template/default.md

      # Push the generated files
      - name: Commit changes
        run: |
          git config --local user.email "[email protected]"
          git config --local user.name "Deployment Overview"
          git add profile
          git commit -m "Add/update deployment overview"

Note that you have to use a GitHub Personal Access Token (PAT) as a secret.

Use as a standalone tool

This action is basically a Go CLI tool that can be run as a standalone tool, this is espcially useful when developing the action.

go buid main.go -o deployment-overview

Run the code

./deployment-overview --github-token <PAT> --organization <organization> --repositories <repository1>,<repository2> --target-repository <target-repository> --target-repository-file <target-repository-file> 

Parameters

Paramter	Environment	Required	Default	Example	Description
--github-token	GITHUB_TOKEN	true	-	-	The GitHub Personal Access Token (PAT)
--environments	ENVIRONMENTS	true	-	dev,staging,prod	Environments to query. Comma separated list.
--organization	ORGANIZATION	true	-	myorga	The GitHub Organization to query for repositories.
--repositories	REPOSITORIES	true	-	frontend,backend	Repositories to query. Comma separated list.
--verbose	VERBOSE	false	1	0	Verbosity level, 0=info, 1=debug. Overrides the environment variable VERBOSE.
--environment-links	ENVIRONMENT_LINKS	false	-	https://dev.example.com,https://staging.example.com,https://www.example.com	Links to the environments. Comma separated list.
--template-file	TEMPLATE_FILE	false	-	template/default.md	The template file to use.
--target-json-file	TARGET_JSON_FILE	false	deployment-overview.json	-	The target file to write the result to as JSON.
--target-md-file	TARGET_MD_FILE	false	deployment-overview.md	-	The target file to write the result to as Markdown.

Required PAT permissions

The PAT should be a Fine Grain PAT that belongs to the target organization and has the following permissions:

Permission	Access
Actions	Read
Deployments	Read
Environments	Read
Metadata	Read
Pull Requests	Read