# Codecov Webpack Plugin
A Webpack plugin that provides bundle analysis support for Codecov.
> [!NOTE]
> The plugin does not support code coverage, see our [docs](https://docs.codecov.com/docs/quick-start) to set up coverage today!
## Installation
Using npm:
```bash
npm install @codecov/webpack-plugin --save-dev
```
Using yarn:
```bash
yarn add @codecov/webpack-plugin --dev
```
Using pnpm:
```bash
pnpm add @codecov/webpack-plugin --save-dev
```
## Public Repo Example - GitHub Actions
This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following [example](#public-repo-example---non-github-actions). For private repositories see the following [example](#private-repo-example).
```js
// webpack.config.js
const path = require("path");
const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");
module.exports = {
entry: "./src/index.js",
mode: "production",
output: {
filename: "main.js",
path: path.resolve(__dirname, "dist"),
},
plugins: [
// Put the Codecov vite plugin after all other plugins
codecovWebpackPlugin({
enableBundleAnalysis: true,
bundleName: "example-webpack-bundle",
uploadToken: process.env.CODECOV_TOKEN,
gitService: "github",
}),
],
};
```
## Public Repo Example - Non-GitHub Actions
This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. `fork-owner:branch`.
```js
// webpack.config.js
const path = require("path");
const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");
module.exports = {
entry: "./src/index.js",
mode: "production",
output: {
filename: "main.js",
path: path.resolve(__dirname, "dist"),
},
plugins: [
// Put the Codecov vite plugin after all other plugins
codecovWebpackPlugin({
enableBundleAnalysis: true,
bundleName: "example-webpack-bundle",
uploadToken: process.env.CODECOV_TOKEN,
gitService: "github",
uploadOverrides: {
branch: "",
},
}),
],
};
```
## Private Repo Example
This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
```js
// webpack.config.js
const path = require("path");
const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");
module.exports = {
entry: "./src/index.js",
mode: "production",
output: {
filename: "main.js",
path: path.resolve(__dirname, "dist"),
},
plugins: [
// Put the Codecov vite plugin after all other plugins
codecovWebpackPlugin({
enableBundleAnalysis: true,
bundleName: "example-webpack-bundle",
uploadToken: process.env.CODECOV_TOKEN,
}),
],
};
```
## OIDC Configuration Example
For users with [OpenID Connect (OIDC) enabled](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect), setting the `uploadToken` is not necessary. You can use OIDC with the `oidc` configuration as following.
```js
// webpack.config.js
const path = require("path");
const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");
module.exports = {
entry: "./src/index.js",
mode: "production",
output: {
filename: "main.js",
path: path.resolve(__dirname, "dist"),
},
plugins: [
// Put the Codecov vite plugin after all other plugins
codecovWebpackPlugin({
enableBundleAnalysis: true,
bundleName: "example-webpack-bundle",
oidc: {
useGitHubOIDC: true,
},
}),
],
};
```
## More information
- [Webpack Config Docs](https://codecov.github.io/codecov-javascript-bundler-plugins/modules/_codecov_webpack_plugin.html)
- [Codecov Documentation](https://docs.codecov.com/docs)
- [Codecov Feedback](https://github.com/codecov/feedback/discussions)
- [Sentry Discord](https://discord.gg/Ww9hbqr)