https://github.com/newrelic-apps/capture-build-size
A GitHub Action to capture a New Relic event describing your build size metrics.
https://github.com/newrelic-apps/capture-build-size
build-size bundle-size webpack
Last synced: about 1 month ago
JSON representation
A GitHub Action to capture a New Relic event describing your build size metrics.
- Host: GitHub
- URL: https://github.com/newrelic-apps/capture-build-size
- Owner: newrelic-apps
- License: apache-2.0
- Created: 2024-12-27T20:32:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-06T23:23:58.000Z (over 1 year ago)
- Last Synced: 2025-04-05T18:52:30.214Z (about 1 year ago)
- Topics: build-size, bundle-size, webpack
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/new-relic-capture-build-size
- Size: 309 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/newrelic/open-source-office/blob/master/examples/categories/index.md#category-community-project)
# New Relic Capture Build Size
[](https://github.com/marketplace/actions/new-relic-capture-build-size)
A GitHub Action to capture a New Relic event describing your build size metrics.
## Inputs
| Key | Required | Default | Description |
| --- | --- | --- | --- |
| `analysis-file-contents` | **If `analysis-type` is not `manual` and no `analysis-file-url` values are supplied** | - | Build analysis file contents -- Takes precendence over analysis-file-url when both are supplied. |
| `analysis-file-url` | **If `analysis-type` is not `manual` and no `analysis-file-contents` values are supplied** | - | Public URL to the analysis file - When supplied without the analysis-file-contents, the action will fetch the file contents from the URL. It will decorate all events created with a link to the uploaded asset. |
| `analysis-type` | **If using `manual-*` values, must be `manual` | `webpack` | Type of analysis file to parse. Please note: `webpack` assumes the file supplied was generated using [webpack-bundle-analyzer](https://www.npmjs.com/package/webpack-bundle-analyzer)|
| `commit` | - | `github.sha` | Commit identifier of the build |
| `event-type` | - | `BuildSize` | Type of event to be captured |
| `file-name-filter` | - | - | When supplied, will only include **entrypoint** file names that include the given substring - When undefined, will include everything in the analysis file |
| `manual-analysis-file-name` | **If `analysis-type` is `manual`** | - | Manually supply the file name of your build - Takes precendence over analysis-file-contents and analysis-file-url when supplied. Only works if analysis-type is "manual" |
| `manual-analysis-file-size` | **If `analysis-type` is `manual`** | - | Manually supply the file name of your build - Takes precendence over analysis-file-contents and analysis-file-url when supplied. Only works if analysis-type is "manual" |
| `manual-analysis-gzip-size` | **If `analysis-type` is `manual`** | - | Manually supply the file name of your build - Takes precendence over analysis-file-contents and analysis-file-url when supplied. Only works if analysis-type is "manual" |
| `nr-account-id` | **Always** | - | New Relic Account ID to be used to capture events |
| `nr-api-key` | **Always** | - | New Relic API key to be used to capture events |
| `nr-env` | - | `US` | NR Environment to be used to capture events. Valid values are `US`. `EU` to be supported in the future |
| `traverse` | - | `false` | When true, will traverse all subtrees and capture events for each item. Currently only supports `webpack` analysis type. |
| `trigger` | - | `github.workflow` | Trigger of the capturing the build size. Can be useful if you have differing reasons or jobs for capturing the build size across your repository. |
| `user` | - | `github.actor` | User who triggered the build |
| `version` | - | `github.ref_name` | Version of the build |
## Example usage
### GitHub secrets
[Github secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#about-encrypted-secrets) assumed to be set:
* `NEW_RELIC_API_KEY` - New Relic API key
* `NEW_RELIC_ACCOUNT_ID` - New Relic Account ID
>*There are a number of [default GitHub environment variables](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables) that are used in these examples as well.*
### Minimum required fields - analysis-file-url
```yaml
name: Capture Build Size With New Relic
on:
workflow_dispatch:
push:
jobs:
report-build-size:
runs-on: ubuntu-latest
name: Report Webpack Stats To New Relic
steps:
- name: Checkout
uses: actions/checkout@v4
# This step parses the build stats (URL) and creates NR events
- name: Capture Build Size
uses: newrelic/capture-build-size@v1.0.0
with:
analysis-file-url: https://foo.bar/mybuild.stats.json
nr-account-id: ${{ secrets.NEW_RELIC_ACCOUNT_ID }}
nr-api-key: ${{ secrets.NEW_RELIC_API_KEY }}
```
### Minimum required fields - analysis-file-contents
```yaml
name: Capture Build Size With New Relic
on:
workflow_dispatch:
push:
jobs:
report-build-size:
runs-on: ubuntu-latest
name: Report Webpack Stats To New Relic
steps:
- name: Checkout
uses: actions/checkout@v4
# This step builds the code (and includes the webpack-bundle-analyzer)
- name: Build
run: npm run build
# This step reads the locally made stats file (assuming to be located in "./build")
- name: Get local stats file
id: get-stats
shell: bash
run: |
stats=$(cat ./build/mybuild.stats.json); echo "stats=$stats" >> $GITHUB_OUTPUT;
# This step parses the Build stats (file) and creates NR events
- name: Capture Build Size
uses: newrelic/capture-build-size@v1.0.0
with:
analysis-file-contents: ${{ steps.get-stats.output.stats }}
nr-account-id: ${{ secrets.NEW_RELIC_ACCOUNT_ID }}
nr-api-key: ${{ secrets.NEW_RELIC_API_KEY }}
```
### Minimum required fields - manual-*
```yaml
name: Capture Build Size With New Relic
on:
workflow_dispatch:
push:
jobs:
report-build-size:
runs-on: ubuntu-latest
name: Report Webpack Stats To New Relic
steps:
- name: Checkout
uses: actions/checkout@v4
# This step builds the code
- name: Build
run: npm run build
# This step parses the Build stats (file) and creates NR events
- name: Capture Build Size
uses: newrelic/capture-build-size@v1.0.0
with:
analysis-type: 'manual'
manual-analysis-file-name: 'main-Build' # the file name to report
manual-analysis-file-size: 12345 # Some value calculated manually
nr-account-id: ${{ secrets.NEW_RELIC_ACCOUNT_ID }}in your build steps that does not rely on an explicit analysis file like webpack-build-analyzer
nr-api-key: ${{ secrets.NEW_RELIC_API_KEY }}
```
### All input fields example - analysis-file-url
```yaml
name: Capture Build Size With New Relic
on:
pull_request: # run on pull request sync events
jobs:
report-build-size:
runs-on: ubuntu-latest
name: Report Webpack Stats To New Relic
steps:
- name: Checkout
uses: actions/checkout@v4
# This step parses the Build stats (URL) and creates NR events
- name: Capture Build Size
uses: newrelic/capture-build-size@v1.0.0
with:
analysis-file-url: https://foo.bar/mybuild.stats.json # the webpack stats file URL
analysis-type: 'webpack' # parse a webpack stats file
commit: ${{ github.sha }} # the commit that triggered the action
event-type: 'MyBuildSize' # report the event with a custom event type
file-name-filter: '.min.js' # only include entrypoints that are minified
nr-account-id: ${{ secrets.NEW_RELIC_ACCOUNT_ID }} # US environment account
nr-api-key: ${{ secrets.NEW_RELIC_API_KEY }} # US environment api key
nr-env: 'US' # US environment
traverse: true # Will create events for each sub-file in the analysis file
trigger: 'PR' # Indicate the build was tied to a PR
user: ${{ github.actor }} # the user who raised the PR
version: ${{ github.ref_name }} # the PR number tied to the action
```
## Query Your Data
### Basic Query Steps
1. In NR1, log into the account you pointed the action to report to.
2. Select "Query your data"
3. Run the given NRQL query
### Attributes Potentially Available
- "analysisFileUrl"
- "analysisType"
- "commit"
- "entryPoint"
- "fileName"
- "fileSize"
- "gzipSize"
- "isInitialEntrypoint"
- "timestamp"
- "trigger"
- "user"
- "version"
### Track Webpack Entrypoint Sizes Over Time
This example assumes you are collecting `BuildSize` events every time your main branch changes
```sql
FROM BuildSize select latest(fileSize)/1000 as 'KB' where isInitialEntrypoint where version = 'main' facet fileName timeseries since 1 week ago
```
### Track Webpack Async Chunk Sizes Over Time
This example assumes you are collecting `BuildSize` events every time your main branch changes
```sql
FROM BuildSize select latest(fileSize)/1000 as 'KB' where isInitialEntrypoint is not true where version = 'main' facet fileName timeseries since 1 week ago
```
### Compare Build Sizes Across PRs
This examples assumes you are collecting `BuildSize` events every time your main branch changes as well as when a PR is created/updated. Each PR `BuildSize` will have a `version` attribute matching its PR number.
```sql
FROM BuildSize select latest(fileSize)/1000 as 'KB', latest(gzipSize)/1000 as 'GZIP KB', latest(timestamp), latest(commit) as 'SHA' where fileName = facet version
```
### Evaluate deviation across PRs
This examples assumes you are collecting `BuildSize` events every time your main branch changes as well as when a PR is created/updated. Each PR `BuildSize` will have a `version` attribute matching its PR number.
```sql
FROM BuildSize select stddev(fileSize)/1000 as 'Stddev KB' where fileName = facet version
```
### Evaluate builds created by a user
This examples assumes you are collecting `BuildSize` events every time your main branch changes as well as when a PR is created/updated. Each PR `BuildSize` will have a `version` attribute matching its PR number.
```sql
FROM BuildSize select latest(fileSize)/1000 as 'KB', latest(gzipSize)/1000 as 'GZIP KB', latest(timestamp), latest(commit) as 'SHA' where fileName = and user = facet version
```