https://github.com/e18e/action-perfbot
The e18e perfbot creates modernization and performance pull requests on a schedule, similar to dependabot.
https://github.com/e18e/action-perfbot
Last synced: 2 months ago
JSON representation
The e18e perfbot creates modernization and performance pull requests on a schedule, similar to dependabot.
- Host: GitHub
- URL: https://github.com/e18e/action-perfbot
- Owner: e18e
- License: mit
- Created: 2026-01-25T16:01:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-03-04T08:57:51.000Z (4 months ago)
- Last Synced: 2026-03-04T14:57:51.465Z (3 months ago)
- Language: JavaScript
- Size: 8.87 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# e18e/action-perfbot
> [!WARNING]
> This repository is very early stages and is unpublished. Keep an eye out on the [e18e.dev](https://e18e.dev) website for updates.
> A GitHub action for automatically opening modernization and performance PRs
## What it does
This action analyzes the repository for potential modernization and performance improvements on a schedule, then creates pull requests if there are any recommended changes.
Think of this as dependabot but for modernization and performance improvements.
## Usage
```yaml
name: perfbot
on:
schedule:
# Run weekly on Monday at 9am UTC
- cron: '0 9 * * 1'
permissions:
contents: write
pull-requests: write
jobs:
perfbot:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: e18e/action-perfbot@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
## Inputs
| Name | Description | Required | Default |
|------------------------|--------------------------------------------------------------------------------|----------|-------------------------------------------|
| `github-token` | The GitHub token for authentication | Yes | `${{ github.token }}` |
| `working-directory` | Working directory relative to repository root | No | `.` |
| `include` | Glob patterns for source files to scan (comma-separated) | No | `src/**/*.{js,ts,mjs,mts,cjs,cts}` |
| `base-branch` | The base branch to create PRs against | No | `main` |
| `branch-prefix` | Prefix for the PR branch name | No | `e18e-perfbot` |
## Example Workflows
See the [`recipes/`](./recipes/) directory for complete workflow examples:
- [`basic.yml`](./recipes/basic.yml) - Basic scheduled perfbot
## Permissions
The action requires the following permissions:
```yaml
permissions:
contents: write # To create branches and push changes
pull-requests: write # To create pull requests
```
## Sponsors
## License
MIT