MIT License
Automatically raise a PR to a downstream repo whenever a file changes.
The repos to submit PRs to are controller using a configuration file that looks like the following:
{
"mheap/downstream": [
{
"src": "my-file.yaml",
"dest": "a-folder/mf.yaml"
}
],
"mheap/other-repo": [
{
"src": "multiple.yaml",
"dest": "multiple.yaml"
},
{
"src": "files-work.yaml",
"dest": "too.yaml"
}
]
}
name: Raise PR on change
on:
pull_request:
types: [closed]
jobs:
raise-pr-on-change:
if: github.event.pull_request.merged == true
name: Raise PR on change
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Raise PR on change
uses: mheap/raise-pr-on-change-action@v1
with:
token: ${{ secrets.PAT }}
configFile: ".github/raise-pr-on-change.json"
prBranch: automated-update
targetBranch: main
prTitle: "Automated update X"
prBody: "This adds files based on upstream repo Y"
commitMessage: "feat(sdk): automated oas update"
Name | Description | Required | Default |
---|---|---|---|
token |
The GitHub auth token, used to authenticate API requests. A Personal Access Token with the repo scope is required as the default GITHUB_TOKEN does not have enough permissions. |
true | |
mode |
Should we rely on the PR files changes, or check the contents in the upstream repo | false | check-upstream |
configFile |
A file containing downstream repos and any file paths that need updating | false | .github/raise-pr-on-change.json |
prBranch |
The branch to push changes to before submitting a PR | false | |
targetBranch |
The branch to target when opening a PR | false | |
prTitle |
The PR title to use | true | |
prBody |
The PR body to use | true | |
commitMessage |
The commit message use | false | Automated OAS update: {file list} |