https://github.com/int128/list-associated-pull-requests-action
List associated pull requests of a pull request in monorepo by GitHub Actions
https://github.com/int128/list-associated-pull-requests-action
github-actions monorepo release-notes
Last synced: 22 days ago
JSON representation
List associated pull requests of a pull request in monorepo by GitHub Actions
- Host: GitHub
- URL: https://github.com/int128/list-associated-pull-requests-action
- Owner: int128
- License: apache-2.0
- Created: 2022-02-20T08:30:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T21:06:43.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T00:14:46.368Z (almost 2 years ago)
- Topics: github-actions, monorepo, release-notes
- Language: TypeScript
- Homepage:
- Size: 5.41 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# list-associated-pull-requests-action [](https://github.com/int128/list-associated-pull-requests-action/actions/workflows/ts.yaml)
This is an action to generate a list of pull requests associated to a pull request.
## Purpose
### Problem to solve
For a mono repository (monorepo) and Git/GitLab Flow, we create a pull request to deploy changes to an environment such as production.
```mermaid
gitGraph
commit id: "Initial"
branch production
checkout main
commit id: "A"
commit id: "B"
commit id: "C"
checkout production
merge main
checkout main
commit id: "D"
commit id: "E"
commit id: "F"
checkout production
merge main
checkout main
commit id: "G"
```
A pull request often becomes too large to review, for example,
### How to solve
This action inspects a pull request and extracts the associated pull requests.
It brings the following benefits:
- You can review what to deploy
- If a repository consists of Microservices, each team can review changes of their service
## Inspect a pull request
You can generate the list of the pull requests associated to the current pull request.
```yaml
on:
pull_request:
jobs:
comment:
runs-on: ubuntu-latest
steps:
- uses: int128/list-associated-pull-requests-action@v1
id: associated-pull-requests
with:
pull-request: ${{ github.event.number }}
# post it to the current pull request
- uses: int128/comment-action@v1
with:
post: |
## Associated pull requests
${{ steps.associated-pull-requests.outputs.body }}
```
This action resolves associated pull requests by the following steps:
1. Find the commits between base and head branch using GitHub Compare API
2. Fetch the associated pull requests using GitHub GraphQL API
Here is an example.
## Group by paths
You can group associated pull requests by paths.
This feature is useful for monorepo.
```yaml
- uses: int128/list-associated-pull-requests-action@v1
with:
group-by-paths: |
backend
frontend
```
Here is an example.
You can put a comment into `group-by-paths`.
This action ignores a line which starts with `#`.
For example,
```yaml
- uses: int128/list-associated-pull-requests-action@v1
with:
group-by-paths: |
# microservices
payment-frontend
payment-backend
# monolith
frontend
api
```
### How it groups
This action fetches the following lists:
- A list of pull requests associated to a pull request
- A list of commits of subtree for each path
If a commit exists in a path, the associated pull requests of the commit are grouped to the path.
For example, if the following commits exist,
- Commit A, Pull Request #1, changed paths are `api` and `backend`
- Commit B, Pull Request #2, changed path is `api`
- Commit C, Pull Request #3, changed path is `backend`
this action returns the following markdown:
```markdown
### api
- #1
- #2
### backend
- #1
- #3
```
### Others group
If a pull request does not belong to any group, it is grouped as "Others".
You can hide the Others group by `show-others-group`.
## Compare base and head
You can generate the list of the pull requests between base and head branch.
```yaml
jobs:
comment:
runs-on: ubuntu-latest
steps:
- uses: int128/list-associated-pull-requests-action@v1
id: associated-pull-requests
with:
base: production
head: main
# post it to the current pull request
- uses: int128/comment-action@v1
with:
post: |
## Associated pull requests
${{ steps.associated-pull-requests.outputs.body }}
```
## Specification
### Inputs
| Name | Default | Description |
| ------------------- | -------------- | ----------------------------------------- |
| `token` | `github.token` | GitHub token |
| `pull-request` | \*1 | Pull request to parse |
| `group-by-paths` | (optional) | Group pull requests by paths (Multiline) |
| `show-others-group` | `true` | Show others group |
| `base` | \*1 | Base branch |
| `head` | \*1 | Head branch |
| `path` | `.` | Path to get the commit history of subtree |
| `max-fetch-commits` | (unlimited) | Maximum number of commits to fetch |
| `max-fetch-days` | (unlimited) | Maximum number of days to fetch history |
You need to set either `base` and `head`, or `pull-request`.
If there is a very old commit in the repository, this action may fetch a lot of commits.
You can set `max-fetch-commits` or `max-fetch-days` to avoid the job timeout or GitHub API rate-limit.
### Outputs
| Name | Description |
| ------------- | ---------------------------------------------------- |
| `body` | List of associated pull requests (Markdown) |
| `body-groups` | Grouped lists of associated pull requests (Markdown) |
| `body-others` | Others list of associated pull requests (Markdown) |
| `json` | List of associated pull requests (JSON) |
#### `json` output
Here is an example of `json` output.
```json
{
"groups": {
"frontend": [
{
"commitId": "aba1fb9e861f34176727a527a6e5af8ba74f628c",
"pull": {
"number": 89,
"title": "refactor: split basehead.ts",
"author": "int128"
}
}
]
},
"others": []
}
```
See the type definition in [src/history.ts](src/history.ts).