Skip to content

Commit 52ad0ef

Browse files
authored
chore: Update READMEs (#51)
Update and add `README.md` files across the packages we want to release. - remove old `hackweek-sentry-unplugin` links - make warnings that this is a heavy WIP more explicit - add Readme to the core sentry-unplugin package
1 parent ad78c73 commit 52ad0ef

File tree

6 files changed

+53
-14
lines changed

6 files changed

+53
-14
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,30 @@
44
</a>
55
</p>
66

7-
# Sentry Unplugin
7+
# Sentry Unplugin (WIP)
88

9-
**DISCLAIMER: This package is work in progress and not production ready. Use with caution. We're happy to receive your feedback!**
9+
**WARNING: This project is work in progress! Do not yet use it in production. We're happy to receive your feedback!**
1010

1111
Universal Sentry plugin for various JavaScript bundlers. Based on [unjs/uplugin](https://github.com/unjs/unplugin). Currently supports Rollup, Vite, esbuild, Webpack 4 and Webpack 5.
1212

1313
Check out the individual packages for more information and examples:
1414

15-
- [Rollup](https://github.com/getsentry/hackweek-sentry-unplugin/tree/main/packages/rollup-plugin)
16-
- [Vite](https://github.com/getsentry/hackweek-sentry-unplugin/tree/main/packages/vite-plugin)
17-
- [esbuild](https://github.com/getsentry/hackweek-sentry-unplugin/tree/main/packages/esbuild-plugin)
18-
- [Webpack](https://github.com/getsentry/hackweek-sentry-unplugin/tree/main/packages/webpack-plugin)
15+
- [Rollup](https://github.com/getsentry/sentry-unplugin/tree/main/packages/rollup-plugin)
16+
- [Vite](https://github.com/getsentry/sentry-unplugin/tree/main/packages/vite-plugin)
17+
- [esbuild](https://github.com/getsentry/sentry-unplugin/tree/main/packages/esbuild-plugin)
18+
- [Webpack](https://github.com/getsentry/sentry-unplugin/tree/main/packages/webpack-plugin)
1919

2020
### Features
2121

22-
The Sentry Unplugin supports [Sentry CLI](https://docs.sentry.io/learn/cli/) features required for node environments:
22+
The Sentry Unplugin take care of Sentry-related tasks at build time of your JavaScript projects. It supports the following features:
2323

2424
- Sourcemap upload
2525
- Release creation in Sentry
2626
- Automatic release name discovery (based on CI environment - Vercel, AWS, Heroku, CircleCI, or current Git SHA)
2727
- Automatically associate errors with releases (Release injection)
2828

29+
The Sentry Unplugin can be used as a replacement of [Sentry CLI](https://docs.sentry.io/learn/cli/) for these tasks.
30+
2931
### More information
3032

3133
- [Sentry Documentation](https://docs.sentry.io/quickstart/)

packages/esbuild-plugin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
</a>
55
</p>
66

7-
# Sentry Esbuild Plugin
7+
# Sentry Esbuild Plugin (WIP)
88

9-
**DISCLAIMER: This package is work in progress and not production ready. Use with caution. We're happy to receive your feedback!**
9+
**WARNING: This package is work in progress! Use with caution and do not yet use it in production. We're happy to receive your feedback!**
1010

1111
A esbuild plugin that provides release management features for Sentry:
1212

packages/rollup-plugin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Sentry Rollup Plugin
88

9-
**DISCLAIMER: This package is work in progress and not production ready. Use with caution. We're happy to receive your feedback!**
9+
**WARNING: This package is work in progress! Use with caution and do not yet use it in production. We're happy to receive your feedback!**
1010

1111
A Rollup plugin that provides release management features for Sentry:
1212

packages/unplugin/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<p align="center">
2+
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
3+
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
4+
</a>
5+
</p>
6+
7+
# Sentry Unplugin (WIP)
8+
9+
**WARNING: This package is work in progress! Do not yet use it in production. We're happy to receive your feedback!**
10+
11+
Core package containing the bundler-agnostic functionality used by the bundler plugins.
12+
13+
Check out the individual packages for more information and examples:
14+
15+
- [Rollup](https://github.com/getsentry/sentry-unplugin/tree/main/packages/rollup-plugin)
16+
- [Vite](https://github.com/getsentry/sentry-unplugin/tree/main/packages/vite-plugin)
17+
- [esbuild](https://github.com/getsentry/sentry-unplugin/tree/main/packages/esbuild-plugin)
18+
- [Webpack](https://github.com/getsentry/sentry-unplugin/tree/main/packages/webpack-plugin)
19+
20+
### Features
21+
22+
The Sentry Unplugin take care of Sentry-related tasks at build time of your JavaScript projects. It supports the following features:
23+
24+
- Sourcemap upload
25+
- Release creation in Sentry
26+
- Automatic release name discovery (based on CI environment - Vercel, AWS, Heroku, CircleCI, or current Git SHA)
27+
- Automatically associate errors with releases (Release injection)
28+
29+
The Sentry Unplugin can be used as a replacement of [Sentry CLI](https://docs.sentry.io/learn/cli/) for these tasks.
30+
31+
### More information
32+
33+
- [Sentry Documentation](https://docs.sentry.io/quickstart/)
34+
- [Troubleshooting Sourcemaps](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/)
35+
- [Sentry CLI](https://docs.sentry.io/learn/cli/)
36+
- [Sentry Discord](https://discord.gg/Ww9hbqr)
37+
- [Sentry Stackoverflow](http://stackoverflow.com/questions/tagged/sentry)

packages/vite-plugin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
</a>
55
</p>
66

7-
# Sentry Vite Plugin
7+
# Sentry Vite Plugin (WIP)
88

9-
**DISCLAIMER: This package is work in progress and not production ready. Use with caution. We're happy to receive your feedback!**
9+
**WARNING: This package is work in progress! Use with caution and do not yet use it in production. We're happy to receive your feedback!**
1010

1111
A Vite plugin that provides release management features for Sentry:
1212

packages/webpack-plugin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
</a>
55
</p>
66

7-
# Sentry Webpack Plugin
7+
# Sentry Webpack Plugin (WIP)
88

9-
**DISCLAIMER: This package is work in progress and not production ready. Use with caution. We're happy to receive your feedback!**
9+
**WARNING: This package is work in progress! Use with caution and do not yet use it in production. We're happy to receive your feedback!**
1010

1111
A Webpack plugin that provides release management features for Sentry:
1212

0 commit comments

Comments
 (0)