GitHub Action
Custom Approval Management
This GitHub Action enables the addition of various teams and their members to the approval process, specifying the required number of members from each team. This is particularly useful, for example, when orchestrating a production deployment that requires explicit approval from the QA team, Product team, Development team, etc., making the process straightforward, simple, and transparent.
To setup this action except typical workflow config you will also need to setup approval config
teams:
dev-team:
members: # team members that can approve this PR
- user1
- user2
- user3
- user4
required: 2 # required number of members for approval
qa-team:
members: # team members that can approve this PR
- user1
- user2
- user3
- user4
required: 4 # required number of members for approval
product-team:
members: # team members that can approve this PR
- user1
- user2
- user3
- user4
required: 1 # required number of members for approval
other-team:
members: # team members that can approve this PR
- user1
- user2
required: 1 # required number of members for approvalDefault path for this configuration is `.github/custom_approval.yml
Create personal access token with org:read permisions https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
and add it as a secret to the repository https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions
Create a workflow file in .github/workflows (e.g. .github/workflows/prod|stage|dev_approval.yml):
name: Require Members Approval
on:
pull_request:
pull_request_review:
types: [editted, submitted]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
require_members_approval:
name: Require Members Approval
runs-on: ubuntu-latest
steps:
- name: Request review based on files changes and/or groups the author belongs to
uses: creotiv/[email protected]
with:
token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
config: .github/custom_approval.yml # Config file location override!!! Please note that users not auto-asigned with this action, you need use CODEOWNERS feature for this