\n\n# Codecov Astro Plugin\n\nAn Astro integration that provides bundle analysis support for Codecov.\n\n> [!NOTE]\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\nnpx astro add @codecov/astro-plugin\n```\n\nUsing yarn:\n\n```bash\nyarn astro add @codecov/astro-plugin\n```\n\nUsing pnpm:\n\n```bash\npnpm astro add @codecov/astro-plugin\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```js\n// astro.config.mjs\nimport { defineConfig } from \"astro/config\";\nimport { codecovAstroPlugin } from \"@codecov/astro-plugin\";\n\n// https://astro.build/config\nexport default defineConfig({\n // other config settings\n integrations: [\n // place this after all other integrations\n codecovAstroPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-astro-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```js\n// astro.config.mjs\nimport { defineConfig } from \"astro/config\";\nimport { codecovAstroPlugin } from \"@codecov/astro-plugin\";\n\n// https://astro.build/config\nexport default defineConfig({\n // other config settings\n integrations: [\n // place this after all other integrations\n codecovAstroPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-astro-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\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```js\n// astro.config.mjs\nimport { defineConfig } from \"astro/config\";\nimport { codecovAstroPlugin } from \"@codecov/astro-plugin\";\n\n// https://astro.build/config\nexport default defineConfig({\n // other config settings\n integrations: [\n // place this after all other integrations\n codecovAstroPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-astro-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```js\n// astro.config.mjs\nimport { defineConfig } from \"astro/config\";\nimport { codecovAstroPlugin } from \"@codecov/astro-plugin\";\n\n// https://astro.build/config\nexport default defineConfig({\n // other config settings\n integrations: [\n // place this after all other integrations\n codecovAstroPlugin({\n enableBundleAnalysis: true,\n bundleName: \"example-astro-bundle\",\n oidc: {\n useGitHubOIDC: true,\n },\n }),\n ],\n});\n```\n\n## More information\n\n- [Astro Plugin Docs](https://codecov.github.io/codecov-javascript-bundler-plugins/modules/_codecov_astro_integration.html)\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