GitHub Action

To enable automated, regular scans of GitHub Action workflows, it's possible to run Proaction as a GitHub Action itself. This will create automated pull requests to the repo where there are changes available.

To enable this, you'll need a Personal Access Token with repo and workflow scope. By default, the GITHUB_TOKEN secret doesn't have the workflow scope and, as a result, cannot create pull requests to any files in the .github/workflows directory.

Sample Workflow

To start, create a secret in the repo named PROACTION_TOKEN and provide the Personal Access Token value created above. Then, create a file named .github/workflows/proaction.yaml with the following content:

on:
schedule:
- cron: "0 0 * * *"
jobs:
run-proaction:
runs-on: ubuntu-18.04
steps:
- uses: actions/[email protected]
- uses: proactionhq/proaction/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
- uses: peter-evans/create-pull-[email protected]
with:
commit-message: "[proaction] updating workflow"
title: Updating workflow from Proaction
token: $${{ secrets.PROACTION_TOKEN }}

This workflow will run daily and create pull requests with any updates found.

Action Inputs

All inputs are optional. It not set, sane defaults will be applied.

NameDescriptionDefault
workflow-filesA reference to the specific workflow file(s) to scan.github/workflows/**