Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eygraber/autobase-action
Automatically rebases a PR with a specific label onto the default branch.
https://github.com/eygraber/autobase-action
Last synced: 5 days ago
JSON representation
Automatically rebases a PR with a specific label onto the default branch.
- Host: GitHub
- URL: https://github.com/eygraber/autobase-action
- Owner: eygraber
- License: mit
- Created: 2023-11-06T19:04:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T14:25:27.000Z (22 days ago)
- Last Synced: 2024-10-24T21:40:02.788Z (21 days ago)
- Language: TypeScript
- Homepage:
- Size: 518 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Autobase Action
This GitHub Action automatically rebases pull requests in your repository when certain conditions are met.
[](https://github.com/super-linter/super-linter)
[](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
[](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
[](./badges/coverage.svg)
## What this action does
When a pull request is merged or a check_suite fails, this action checks for other open pull requests that are labeled with a specific tag (by default `autobase`). If the merged / failed pull request's base is the repository's default branch and other conditions (like required approvals) are met, the action will attempt to rebase the next available pull request starting with the oldest of the pull requests. If that fails it moves on to the next one, until one succeeds or there are no more pull requests to try to rebase.
## Inputs
| Input | Description | Required | Default |
|------------------------|-------------------------------------------------------------|:--------:|---------|
| `github-token` | The GitHub token used to authenticate requests. | Yes | N/A |
| `label` | The label which the pull request must have to be rebased. | No | autobase|
| `required-approvals` | The number of approvals required before rebasing. | No | 0 |
| `base-branch` | The base branch to check for before rebasing. | No | default branch of the repository |
## Outputs
_None. This action does not set any outputs._
## Token Permissions
To use this action, you must provide a `github-token` with the appropriate permissions. GitHub does not trigger new workflow runs on events caused by the default `GITHUB_TOKEN` for actions ([see here for more info](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow)). Therefore, you need to create a Personal Access Token (PAT) with the required scopes and use it within your workflow to circumvent this limitation.
### Creating a Personal Access Token (PAT)
1. Go to your GitHub settings.
2. Under Developer settings, choose Personal Access Tokens.
3. Generate a new token with at least the `repo` scope for public repositories, or the `repo` and `workflow` scopes for private repositories.
4. Save the generated token, as you will not be able to view it again.
### Using the Personal Access Token in your workflow
After creating your PAT, you should store it as a secret in your repository:
1. Go to your repository's Settings tab.
2. Click on Secrets in the left sidebar.
3. Add a new secret with the name `AUTOBASE_TOKEN` and paste your PAT as the value.
Note: It is crucial to keep your PAT secure. Use it only when necessary and do not share it publicly.
## Example usage
```yml
name: Autobase
on:
pull_request:
types: [closed]
check_suite:
types: [completed]
# Concurrency ensures that only one instance of the workflow runs for a given pull request or check suite.
concurrency:
group: autobase-${{ github.event.pull_request.number || github.event.check_suite.id }}
cancel-in-progress: false
jobs:
autobase:
runs-on: ubuntu-latest
if: (github.event.pull_request.merged == true) || (github.event.check_suite.conclusion == 'failure')
steps:
- name: Checkout
uses: actions/checkout@v4
with:
token: ${{ secrets.AUTOBASE_TOKEN }}
- name: Autobase
uses: eygraber/autobase-action@v1
with:
github-token: ${{ secrets.AUTOBASE_TOKEN }}
```