Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 5 days 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 (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-28T08:09:03.000Z (19 days ago)
- Last Synced: 2024-10-28T09:36:53.011Z (19 days ago)
- Topics: actions, github, versioning
- Language: TypeScript
- Homepage:
- Size: 3.28 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
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
[](https://github.com/VanOns/get-merged-pull-requests-action/actions/workflows/test.yml)
[](https://github.com/VanOns/get-merged-pull-requests-action/blob/main/LICENSE)
[](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: ""
# 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)**
```json
[{ "title": "Title of the pull request" }]
```
- **`all`**: see [here][return-format-overview] 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][all-contributors]
## License
The scripts and documentation in this project are released under the [MIT License][license].
---
[return-format-overview]: https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-issues-and-pull-requests
[documentation]: docs
[contributing]: CONTRIBUTING.md
[changelog]: CHANGELOG.md
[upgrading]: UPGRADING.md
[security]: SECURITY.md
[email]: mailto:[email protected]
[all-contributors]: ../../contributors
[license]: LICENSE.md