README.md

SuperSnyk 🦸

A Github Action to merge automated Snyk PRs against your repo into a single SuperSnyk 🦸 PR

• PRs are detected via the incoming branch name (snyk-fix-* or snyk-update-*) and PR title [Snyk] *
• Snyk PRs will be automatically labelled with snyk label
• All Snyk PRs with the snyk label are merged together into a single SuperSnyk 🦸 PR targeting your "default" branch (defaults to main)
• SuperSnyk 🦸 PR body will be automatically updated with a reference to each child Synk PR using autolink reference
• Merging the SuperSnyk 🦸 PR will close all the snyky child PRs 😛

Usage

on:
  push:
    branches:
      - "snyk-upgrade-*"
      - "snyk-fix-*"

jobs:
  SuperSnyk:
    runs-on: ubuntu-latest
    steps:
      - uses: mishabruml/supersnyk@<tag>
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          main_branch_name: master # optional

Inputs

Name	Description	Required	Default
github_token	GITHUB_TOKEN (permissions contents: write and pull-requests: write) or a repo scoped Personal Access Token (PAT).	✅
main_branch_name	The name of the main/default branch of your repo.	❌	main

Motivation

Why does this project exist? Because I got tired of merging billions of snyk PRs one-by-one, waiting for CI, merging main back into the fix branch, waiting for CI... 😴

The first rule of any technology used in a business is that automation applied to an efficient operation will magnify the efficiency. The second is that automation applied to an inefficient operation will magnify the inefficiency.

Bill Gates

Dependencies/Credits

This project makes use of some other Github Actions:

bobvanderlinden/combine-pull-requests

peter-evans/create-pull-request