\n\n# Codecov Remix Plugin\n\nA Remix plugin that provides bundle analysis support for Codecov.\n\n> [!NOTE]\n> This plugin only supports Remix 2.x when building with Vite.\n>\n> The plugin does not support code coverage, see our [docs](https://docs.codecov.com/docs/quick-start) to set up coverage today!\n\n## Installation\n\nUsing npm:\n\n```bash\nnpm install @codecov/remix-vite-plugin --save-dev\n```\n\nUsing yarn:\n\n```bash\nyarn add @codecov/remix-vite-plugin --dev\n```\n\nUsing pnpm:\n\n```bash\npnpm add @codecov/remix-vite-plugin --save-dev\n```\n\n## Public Repo Example - GitHub Actions\n\nThis 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).\n\n```ts\n// vite.config.ts\nimport { vitePlugin as remix } from \"@remix-run/dev\";\nimport { defineConfig } from \"vite\";\nimport tsconfigPaths from \"vite-tsconfig-paths\";\nimport { codecovRemixPlugin } from \"@codecov/remix-vite-plugin\";\n\nexport default defineConfig({\n plugins: [\n remix(),\n tsconfigPaths()\n // Put the Codecov Remix plugin after all other plugins\n codecovRemixPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-remix-bundle\",\n uploadToken: process.env.CODECOV_TOKEN,\n gitService: \"github\",\n }),\n ],\n});\n```\n\n## Public Repo Example - Non-GitHub Actions\n\nThis 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`.\n\n```ts\n// vite.config.ts\nimport { vitePlugin as remix } from \"@remix-run/dev\";\nimport { defineConfig } from \"vite\";\nimport tsconfigPaths from \"vite-tsconfig-paths\";\nimport { codecovRemixPlugin } from \"@codecov/remix-vite-plugin\";\n\nexport default defineConfig({\n plugins: [\n remix(),\n tsconfigPaths()\n // Put the Codecov Remix plugin after all other plugins\n codecovRemixPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-remix-bundle\",\n uploadToken: process.env.CODECOV_TOKEN,\n gitService: \"github\",\n uploadOverrides: {\n branch: \"\",\n },\n }),\n ],\n});\n```\n\n## Private Repo Example\n\nThis is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.\n\n```ts\n// vite.config.ts\nimport { vitePlugin as remix } from \"@remix-run/dev\";\nimport { defineConfig } from \"vite\";\nimport tsconfigPaths from \"vite-tsconfig-paths\";\nimport { codecovRemixPlugin } from \"@codecov/remix-vite-plugin\";\n\nexport default defineConfig({\n plugins: [\n remix(),\n tsconfigPaths()\n // Put the Codecov Remix plugin after all other plugins\n codecovRemixPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-remix-bundle\",\n uploadToken: process.env.CODECOV_TOKEN,\n }),\n ],\n});\n```\n\n## OIDC Configuration Example\n\nFor 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.\n\n```ts\n// vite.config.ts\nimport { vitePlugin as remix } from \"@remix-run/dev\";\nimport { defineConfig } from \"vite\";\nimport tsconfigPaths from \"vite-tsconfig-paths\";\nimport { codecovRemixPlugin } from \"@codecov/remix-vite-plugin\";\n\nexport default defineConfig({\n plugins: [\n remix(),\n tsconfigPaths()\n // Put the Codecov Remix plugin after all other plugins\n codecovRemixPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-remix-bundle\",\n oidc: {\n useGitHubOIDC: true,\n },\n }),\n ],\n});\n```\n\n## More information\n\n- [Codecov Documentation](https://docs.codecov.com/docs)\n- [Codecov Feedback](https://github.com/codecov/feedback/discussions)\n- [Sentry Discord](https://discord.gg/Ww9hbqr)\n","readmeFilename":"README.md"}
![\"Codecov](\"https://about.codecov.io/wp-content/themes/codecov/assets/brand/sentry-cobranding/logos/codecov-by-sentry-logo.svg\"){kind=logo}
\n \n