Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prodyna/deployment-overview
GitHub Action that gives a deployment overview for all projects in the defined organization
https://github.com/prodyna/deployment-overview
docker github github-actions go
Last synced: about 2 months ago
JSON representation
GitHub Action that gives a deployment overview for all projects in the defined organization
- Host: GitHub
- URL: https://github.com/prodyna/deployment-overview
- Owner: PRODYNA
- License: mit
- Created: 2024-02-29T10:50:05.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-17T21:11:22.000Z (10 months ago)
- Last Synced: 2024-03-18T21:59:15.035Z (10 months ago)
- Topics: docker, github, github-actions, go
- Language: Go
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](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](https://dev-yasm.prodyna.com) | [staging](https://dev-yasm.prodyna.com) | [prod](https://yasm.prodyna.com) |
| --- | --- | --- | -- | --- | --- | --- |
| [yasm-backend](https://github.com/prodyna-yasm/yasm-backend) | :red_square: 1 | :yellow_square: 1 | 1.13.1 | :red_square: e6e2948 | :green_square: 1.13.1 | :green_square: 1.13.1 |
| [yasm-frontend](https://github.com/prodyna-yasm/yasm-frontend) | :red_square: 11 | :yellow_square: 2 | 1.13.5 | :red_square: 4aa310d | :green_square: 1.13.5 | :green_square: 1.13.5 |
| [yasmctl](https://github.com/prodyna-yasm/yasmctl) | :green_square: 0 | :green_square: 0 | 1.13.3 | :green_square: 1.13.3 | :green_square: 1.13.3 | :green_square: 1.13.3 |
| [yasm-proxy-odbc](https://github.com/prodyna-yasm/yasm-proxy-odbc) | :green_square: 0 | :green_square: 0 | 1.10.0 | :green_square: 1.10.0 | :green_square: 1.10.0 | :green_square: 1.10.0 |
| [yasm-integration](https://github.com/prodyna-yasm/yasm-integration) | :green_square: 0 | :yellow_square: 1 | 1.13.5 | :green_square: 1.13.5 | :green_square: 1.13.5 | :green_square: 1.13.5 |
| [yasm-geocoding](https://github.com/prodyna-yasm/yasm-geocoding) | :red_square: 2 | :green_square: 0 | 1.3.0 | :red_square: ec76731 | :green_square: 1.3.0 | :green_square: 1.3.0 |
| [yasm-data](https://github.com/prodyna-yasm/yasm-data) | :green_square: 0 | :green_square: 0 | 1.9.0 | :green_square: 1.9.0 | :green_square: 1.9.0 | :green_square: 1.9.0 |
| [yasm-gotenberg](https://github.com/prodyna-yasm/yasm-gotenberg) | :green_square: 0 | :green_square: 0 | 8.2.0-3 | :green_square: 8.2.0-3 | :green_square: 8.2.0-3 | :green_square: 8.2.0-3 |
See [EXAMPLE.md](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:
```yaml
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.
```shell
go buid main.go -o deployment-overview
```
### Run the code
```shell
./deployment-overview --github-token --organization --repositories , --target-repository --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 |