BundleMon

When build tools generate files with unique hashes (e.g., main.a1b2c3d4.js), use the <hash> placeholder in your configuration. This allows BundleMon to track the same logical file across different builds even when the filename changes.

"bundlemon": {
  "baseDir": "./build",
  "files": [
    {
      "path": "*.<hash>.chunk.js"
    },
    {
      "path": "*.<hash>.js"
    }
  ]
}

To allow BundleMon to post commit statuses or PR comments on GitHub, you must provide a GitHub access token via the BUNDLEMON_GITHUB_TOKEN environment variable in your CI configuration.

Token Requirements:

• Create a Personal Access Token (PAT) without any specific scopes.
• The token owner must have write permissions to the repository where outputs will be posted.
• The token is used only to verify the username that created it and is not stored by the BundleMon service.

# Set this in your CI environment variables
BUNDLEMON_GITHUB_TOKEN=your_github_access_token

The SECRET_SESSION_KEY is used for securely signing session cookies. While the service auto-generates a key on startup, it is recommended to set a persistent key manually. You can generate a key using the provided script.

yarn install

# prints the secret key
node apps/service/scripts/generateSecretKey.js

To save history and compare against base branches, BundleMon requires a project ID.

1. GitHub Actions: If using the official GitHub App, BundleMon detects this automatically.
2. Other CI/Manual: Create a project at app.bundlemon.dev and set the following environment variables in your CI:
   • BUNDLEMON_PROJECT_ID
   • BUNDLEMON_PROJECT_APIKEY

Install bundlemon as a development dependency using npm or yarn to start monitoring your bundle sizes.

npm install bundlemon --save-dev

# or

yarn add bundlemon --dev

The custom output plugin allows you to use your own JavaScript implementation to process or output BundleMon results. You must provide a path to a JavaScript file that exports a function. This function receives the generated report as its parameter and can be either synchronous or asynchronous.

// Configuration
"reportOutput": [
  [
    "custom",
    {
      "path": "custom-output.js"
    }
  ]
]

The github output plugin allows BundleMon to create GitHub check runs, post commit statuses, and add detailed comments to Pull Requests. To use it, you must first Install the BundleMon GitHub App.

In your configuration, reportOutput accepts either a simple string for default settings or an array containing the plugin name and an options object to override defaults.

// Use default options
"reportOutput": ["github"]

// Override default options
"reportOutput": [
  [
    "github",
    {
      "checkRun": false,
      "commitStatus": true,
      "prComment": true
    }
  ]
]

BundleMon requires a MongoDB instance to store data. You can use any of the following:

• A MongoDB instance running in Docker.
• A local MongoDB installation on your machine.
• A managed service like MongoDB Atlas.

Ensure you provide the connection string to the platform using the MONGO_URL environment variable.

The json output plugin saves the raw BundleMon results into a JSON file. You can use the default filename or specify a custom one via the fileName option.

// Use default options (bundlemon-results.json)
"reportOutput": ["json"]

// Override default options
"reportOutput": [
  [
    "json",
    {
      "fileName": "fantastic-file-name.json"
    }
  ]
]