Skip to content
check

GitHub Action

GitHub PR Merge (Generic)

v0.8.0 Latest version
Use latest version
check

GitHub PR Merge (Generic)

This action merges a PR on a given GitHub repository

Installation

Copy and paste the following snippet into your .yml file.

- name: GitHub PR Merge (Generic)
  uses: justinyoo/github-pr-merge-action@v0.8.0
Learn more about this action in justinyoo/github-pr-merge-action
Choose a version

GitHub PR Merge Action

This is a GitHub Actions that merges a PR with the most generic way.

Inputs

  • authToken: (required) GitHub authentication token
  • owner: (required) GitHub repository owner/organisation.
  • repository: (required) GitHub repository.
  • issueId: (required) GitHub issue ID for the PR.
  • mergeMethod: Merge method to use. Possible values are Merge, Squash or Rebase. If omitted, Merge goes for the default value.
  • commitTitle: Title for the automatic commit message.
  • commitDescription: Extra detail to append to automatic commit message.
  • deleteBranch: Value indicating whether to delete the branch after the PR merge or not. If omitted, false goes for the default value.

Example Usage

steps:
  name: Merge PR
  uses: justinyoo/github-pr-merge-action@v0.8.0
  with:
    authToken: ${{ secrets.GITHUB_TOKEN }}
    owner: <github_username_or_organisation_name>
    repository: <repository_name>
    issueId: '1234'
    mergeMethod: Squash
    commitTitle: ''
    commitDescription: ''
    deleteBranch: 'true'

Contribution

Your contributions are always welcome! All your work should be done in your forked repository. Once you finish your work with corresponding tests, please send us a pull request onto our dev branch for review.

License

GitHub PR Merge Action is released under MIT License

The MIT License (MIT)

Copyright (c) 2020 Justin Yoo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.