This github action updates the description (and/or title) of the PR by the given source and destination branches.
This action doesn't create a PR, but updates it. We recommend you should use this github action with repo-sync/pull-request
name: Creates and Updates PR
on:
push:
branches:
- some-branch
jobs:
pull-request:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: pull-request
uses: repo-sync/pull-request@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
- name: update-pull-request
uses: kt3k/[email protected]
with:
pr_body: "**some description**"
github_token: ${{ secrets.GITHUB_TOKEN }}repo-sync/pull-request creates a PR, but the action doesn't update it if the PR already exists. If you need to update the description of the PR on each push, you can use this action for it.
We creates a pull request from master to release and update the description on each push on master. Merging to release branch causes the actual release to the staging environment. So this github workflow works as the release preparation and we can see what is going to be released at the next release by seeing this pull request.
name: Creates and Updates PR
on:
push:
branches:
- master
jobs:
pull-request:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: create-description
run: "some script for creating PR description from the branch diff"
id: description
- name: pull-request
uses: repo-sync/pull-request@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
destination_branch: release
pr_title: Release
- name: update-pull-request
uses: kt3k/[email protected]
with:
pr_body: ${{ steps.description.outputs.description }}
destination_branch: release
github_token: ${{ secrets.GITHUB_TOKEN }}The GITHUB_TOKEN secret. This is required.
The title of the PR. Optional.
The body of the PR
Base branch of the PR. Default is master.
This action has no outputs.
Apache License, Version 2.0