Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update #1

Merged
merged 1 commit into from
Jun 30, 2021
Merged

docs: update #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: update
  • Loading branch information
@jackleslie
jackleslie committed Jun 29, 2021
commit 9c9e27c5b3ac5cd9643529166c53d4aac0000dae
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ GitHub action that analyses the bundle sizes for each route in a Next.js build.

## Usage

Add the following step to a workflow, after the Next.js project has been built (i.e. after running `yarn build`).
Add the following step to a workflow which runs on a [pull_request](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request) event, after the Next.js project has been built (i.e. after running `yarn build`).

```yml
- name: Analyze bundle sizes
Expand All @@ -15,6 +15,7 @@ Add the following step to a workflow, after the Next.js project has been built (
# Optional, defaults to master
base-branch: master
env:
# This secret is automatically injected by GitHub
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

Expand Down