https://github.com/vanons/get-merged-pull-requests-action

GitHub action that compares 2 tags and retrieves all pull requests merged between them.
https://github.com/vanons/get-merged-pull-requests-action

actions github versioning

Last synced: 9 months ago
JSON representation

GitHub action that compares 2 tags and retrieves all pull requests merged between them.

• Host: GitHub
• URL: https://github.com/vanons/get-merged-pull-requests-action
• Owner: VanOns
• License: mit
• Created: 2023-08-14T12:38:10.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2025-08-04T23:17:49.000Z (10 months ago)
• Last Synced: 2025-08-05T09:32:53.513Z (10 months ago)
• Topics: actions, github, versioning
• Language: TypeScript
• Homepage:
• Size: 3.26 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


# GitHub Action: Get Merged Pull Requests

[![Test build](https://github.com/VanOns/get-merged-pull-requests-action/actions/workflows/test.yml/badge.svg)](https://github.com/VanOns/get-merged-pull-requests-action/actions/workflows/test.yml)

[![GPL-3.0 License](https://img.shields.io/github/license/VanOns/get-merged-pull-requests-action)](https://github.com/VanOns/get-merged-pull-requests-action/blob/main/LICENSE)

[![GitHub Release](https://img.shields.io/github/v/release/VanOns/get-merged-pull-requests-action?sort=semver)](https://github.com/VanOns/get-merged-pull-requests-action/releases/latest)

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

## Quick start

### Usage

```yaml

- 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: ""

    # 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: ""

    # Limit the number of commits to retrieve.

    commit_limit: ""

```

### 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**    |

| **`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][all-contributors]

## License

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

---



[documentation]: docs

[contributing]: CONTRIBUTING.md

[changelog]: CHANGELOG.md

[upgrading]: UPGRADING.md

[security]: SECURITY.md

[email]: mailto:opensource@van-ons.nl

[all-contributors]: ../../contributors

[license]: LICENSE.md