Skip to content

Commit ff552dc

Browse files
authored
docs: Add in disclaimer in the plugin README's (#114)
Modify disclaimer in plugin readme's to indicate that the plugins do not upload coverage to Codecov.
1 parent dd35dcb commit ff552dc

File tree

5 files changed

+13
-0
lines changed

5 files changed

+13
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ It supports the following features:
2626

2727
## More information
2828

29+
- [Plugin Config Docs](https://codecov.github.io/codecov-javascript-bundler-plugins/index.html)
2930
- [Codecov Documentation](https://docs.codecov.com/docs)
3031
- [Codecov Feedback](https://github.com/codecov/feedback/discussions)
3132
- [Sentry Discord](https://discord.gg/Ww9hbqr)

packages/bundler-plugin-core/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
> [!WARNING]
1010
> These plugins are currently in beta and are subject to change.
1111
12+
> The bundler-plugin-core is not to be used individually and is meant to be used in conjunction with the bundler specific plugins.
13+
1214
Core package containing the bundler-agnostic logic for the Codecov Bundler Plugins.
1315

1416
Checkout the individual packages for more information and examples:
@@ -25,6 +27,7 @@ The Codecov Bundler Core package contains the following functionality:
2527

2628
## More information
2729

30+
- [Bundler Config Docs](https://codecov.github.io/codecov-javascript-bundler-plugins/modules/_codecov_bundler_plugin_core.html)
2831
- [Codecov Documentation](https://docs.codecov.com/docs)
2932
- [Codecov Feedback](https://github.com/codecov/feedback/discussions)
3033
- [Sentry Discord](https://discord.gg/Ww9hbqr)

packages/rollup-plugin/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
> These plugins are currently in beta and are subject to change.
1111
1212
> A Rollup plugin that provides bundle analysis support for Codecov.
13+
>
14+
> The plugin does not support code coverage, see our [docs](https://docs.codecov.com/docs/quick-start) to set up coverage today!
1315
1416
## Installation
1517

@@ -52,6 +54,7 @@ export default defineConfig({
5254

5355
## More information
5456

57+
- [Rollup Config Docs](https://codecov.github.io/codecov-javascript-bundler-plugins/modules/_codecov_rollup_plugin.html)
5558
- [Codecov Documentation](https://docs.codecov.com/docs)
5659
- [Codecov Feedback](https://github.com/codecov/feedback/discussions)
5760
- [Sentry Discord](https://discord.gg/Ww9hbqr)

packages/vite-plugin/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
> These plugins are currently in beta and are subject to change.
1111
1212
> A Vite plugin that provides bundle analysis support for Codecov.
13+
>
14+
> The plugin does not support code coverage, see our [docs](https://docs.codecov.com/docs/quick-start) to set up coverage today!
1315
1416
## Installation
1517

@@ -52,6 +54,7 @@ export default defineConfig({
5254

5355
## More information
5456

57+
- [Vite Config Docs](https://codecov.github.io/codecov-javascript-bundler-plugins/modules/_codecov_vite_plugin.html)
5558
- [Codecov Documentation](https://docs.codecov.com/docs)
5659
- [Codecov Feedback](https://github.com/codecov/feedback/discussions)
5760
- [Sentry Discord](https://discord.gg/Ww9hbqr)

packages/webpack-plugin/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
> These plugins are currently in beta and are subject to change.
1111
1212
> A Webpack plugin that provides bundle analysis support for Codecov.
13+
>
14+
> The plugin does not support code coverage, see our [docs](https://docs.codecov.com/docs/quick-start) to set up coverage today!
1315
1416
## Installation
1517

@@ -58,6 +60,7 @@ module.exports = {
5860

5961
## More information
6062

63+
- [Webpack Config Docs](https://codecov.github.io/codecov-javascript-bundler-plugins/modules/_codecov_webpack_plugin.html)
6164
- [Codecov Documentation](https://docs.codecov.com/docs)
6265
- [Codecov Feedback](https://github.com/codecov/feedback/discussions)
6366
- [Sentry Discord](https://discord.gg/Ww9hbqr)

0 commit comments

Comments
 (0)