GitHub Action: Get Merged Pull Requests

Compare two tags and retrieve all the pull requests merged between them.

Quick start

Usage

- uses: VanOns/get-merged-pull-requests-action@v1
  with:
    # The GitHub token to use.
    github_token: ""

    # The repository to use. Defaults to current repository. Expected format:
    # `owner/repo`.
    repo: ""

    # The current tag to use. Defaults to current/latest tag.
    current_tag: ""

    # The previous tag to use. Defaults to one tag before the current tag.
    previous_tag: ""

    # What data to return. Options are: `title_only`, `all`.
    # Default: title_only
    return_type: ""

    # The regex to use to determine if a commit is a pull request merge commit. This
    # is checked against a commit's title. Default regex: `^Merge pull request.*`.
    commit_is_pull_request_regex: ""

    # Whether to apply `commit_is_pull_request_regex` to the commits.
    # Default: false
    apply_commit_is_pull_request_regex: ""

    # The regex to use if you want to filter the pull requests. This is checked
    # against a pull request's title. Example regex: `^\[Feat].*`.
    pull_request_regex: ""

Return format

The pull requests are returned in a certain format, depending on the return_type value:

• title_only (default)

  [{ "title": "Title of the pull request" }]

• all: see here for a full overview.

Inputs

Input	Description	Default	Required
github_token	The GitHub token to use.		true
repo	The repository to use. Defaults to current repository. Expected format: owner/repo.		false
current_tag	The current tag to use. Defaults to current/latest tag.		false
previous_tag	The previous tag to use. Defaults to one tag before the current tag.		false
return_type	What data to return. Options are: title_only, all.	title_only	false
commit_is_pull_request_regex	The regex to use to determine if a commit is a pull request merge commit. This is checked against a commit's title. Default regex: ^Merge pull request.*.		false
apply_commit_is_pull_request_regex	Whether to apply commit_is_pull_request_regex to the commits.		false
pull_request_regex	The regex to use if you want to filter the pull requests. This is checked against a pull request's title. Example regex: ^\[Feat].*.		false
commit_limit	Limit the number of commits to retrieve.	250	false

Documentation

Please see the documentation for detailed information about installation and usage.

Contributing

Please see contributing for more information about how you can contribute.

Changelog

Please see changelog for more information about what has changed recently.

Upgrading

Please see upgrading for more information about how to upgrade.

Security

Please see security for more information about how we deal with security.

Credits

We would like to thank the following contributors for their contributions to this project:

• All Contributors

License

The scripts and documentation in this project are released under the MIT License.

---