Skip to content

Commit f25cf8a

Browse files
gingerbenwgingerbenw
authored
Merge pull request #5 from bugsnag/release/v1.0.0
Release v1.0.0
2 parents 7df32e2 + 0853b64 commit f25cf8a

36 files changed

+9216
-5
lines changed

‎.github/SUPPORT.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Are you having trouble getting started?
2+
3+
If you haven't already, please check out our [documentation](https://docs.bugsnag.com/build-integrations/vite) for guides, references and tutorials.
4+
5+
Or, if you wish, you can [contact us directly](mailto:[email protected]) for assistance on integrating BugSnag into your application, troubleshooting an issue, or if you have a question about our supported features.
6+
7+
When contacting support, please include as much information as necessary, including:
8+
9+
- example code snippet
10+
- steps to reproduce
11+
- expected/actual behaviour
12+
13+
* Node version:
14+
* NPM version:
15+
* Vite version:
16+
17+
## Bug or Feature Requests
18+
19+
If you would like to raise a bug or feature request, please do so by creating a [New Issue](https://github.com/bugsnag/vite-plugin-bugsnag/issues/new/choose) and selecting bug or feature.
20+
Please note: we cannot promise that we will fulfil all requests
21+
22+
## Pull Requests
23+
24+
If you have made a fix and would like to raise a pull request, please read our [CONTRIBUTING.md](../docs/CONTRIBUTING.md) file before creating the pull request.

‎.github/issue_template/A.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Having trouble getting started?
3+
about: Please contact us at [email protected] for assistance with integrating BugSnag
4+
into your application.
5+
title: ''
6+
labels: ''
7+
assignees: ''
8+
9+
---
10+
Please check out our [documentation](https://docs.bugsnag.com/build-integrations/vite/) for guides, references and tutorials.
11+
12+
If you have questions about your integration, please contact us at [[email protected]](mailto:[email protected]).
13+
14+
Alternatively, view additional options at [SUPPORT.md](../SUPPORT.md).

‎.github/issue_template/bug_report.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve the library
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Before raising, please check whether somebody else has already reported your issue. -->
11+
12+
### Describe the bug
13+
A clear and concise description of what the bug is.
14+
15+
### Steps to reproduce
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error
20+
21+
### Environment
22+
* Node version:
23+
* Vite version:
24+
25+
<!--
26+
Below are a few approaches you might take to communicate the issue, in
27+
descending order of awesomeness. Please choose one and feel free to delete
28+
the others from this template.
29+
-->
30+
31+
### Example Repo <!-- Option 1 -->
32+
33+
- [ ] Create a minimal repository that can reproduce the issue
34+
- [ ] Link to it here:
35+
36+
### Example code snippet <!-- Option 2 -->
37+
38+
```
39+
# (Insert code sample to reproduce the problem)
40+
```
41+
42+
<!-- Error messages, if any -->
43+
<details><summary>Error messages:</summary>
44+
45+
```
46+
47+
```
48+
</details>

‎.github/issue_template/feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Before creating, please check whether somebody else has already reported your feature request. -->
11+
12+
### Description
13+
<!-- Is your feature request related to a problem? Please describe.
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
-->
16+
17+
**Describe the solution you'd like**
18+
<!-- A clear and concise description of what you want to happen. -->
19+
20+
**Describe alternatives you've considered**
21+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
22+
23+
**Additional context**
24+
<!--Add any other context about the feature request here.-->

‎.github/pull_request_template.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Goal
2+
3+
<!-- Why is this change necessary? -->
4+
5+
## Design
6+
7+
<!-- Why was this approach used? -->
8+
9+
## Changeset
10+
11+
<!-- What changed? -->
12+
13+
## Testing
14+
15+
<!-- How was it tested? What manual and automated tests were
16+
run/added? -->

‎.github/workflows/unit-tests.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Unit tests
2+
on: push
3+
jobs:
4+
build:
5+
runs-on: ubuntu-24.04
6+
strategy:
7+
matrix:
8+
node: [22]
9+
vite: [6] # 4,5,6 still supported
10+
env:
11+
VITE_VERSION: ${{ matrix.vite }}
12+
steps:
13+
- uses: actions/setup-node@v2
14+
with:
15+
node-version: ${{ matrix.node }}
16+
- name: Checkout PR branch
17+
uses: actions/checkout@v1
18+
- run: npm ci
19+
- run: bin/ci-install.sh
20+
- run: npm test

‎.gitignore‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# vitepress build output
108+
**/.vitepress/dist
109+
110+
# vitepress cache directory
111+
**/.vitepress/cache
112+
113+
# Docusaurus cache and generated files
114+
.docusaurus
115+
116+
# Serverless directories
117+
.serverless/
118+
119+
# FuseBox cache
120+
.fusebox/
121+
122+
# DynamoDB Local files
123+
.dynamodb/
124+
125+
# TernJS port file
126+
.tern-port
127+
128+
# Stores VSCode versions used for testing VSCode extensions
129+
.vscode-test
130+
131+
# yarn v2
132+
.yarn/cache
133+
.yarn/unplugged
134+
.yarn/build-state.yml
135+
.yarn/install-state.gz
136+
.pnp.*

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## [1.0.0] - 2025-06-25
2+
3+
Initial release 🚀

‎CONTRIBUTING.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# How to contribute
2+
3+
## Reporting issues
4+
5+
If you think you've spotted a problem with this module, feel free to open up a
6+
[new issue](https://github.com/bugsnag/vite-plugin-bugsnag/issues/new). There are a couple
7+
of things you should check before doing so:
8+
9+
- Do you have the latest version of vite-plugin-bugsnag? If not, does updating to the latest
10+
version fix your issue?
11+
- Has somebody else [already reported](https://github.com/bugsnag/vite-plugin-bugsnag/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen)
12+
your issue? Feel free to comment or check-in on an existing issue that matches your own.
13+
- Is your problem definitely to do with this module? For anything else, email [[email protected]](mailto:[email protected]).
14+
15+
## Fixing issues
16+
17+
If you've identified a fix to a new or existing issue, we welcome contributions!
18+
19+
- [Fork](https://help.github.com/articles/fork-a-repo) the [repo on github](https://github.com/bugsnag/vite-plugin-bugsnag)
20+
- Make your changes locally
21+
- Ensure the changes pass tests (`npm test`)
22+
- Commit and push your changes
23+
- [Make a pull request](https://help.github.com/articles/using-pull-requests)
24+
- Ensure CI passes (and if it fails, attempt to address the cause)
25+
26+
## Adding features
27+
28+
In general, feature additions will come from Bugsnag employees. If you think you have
29+
a useful addition that doesn’t take long to create a pull request for, feel free
30+
to go ahead and make it and strike up a discussion. With any non-trivial amount
31+
of work, the best thing to do is [create an issue](https://github.com/bugsnag/vite-plugin-bugsnag/issues/new)
32+
in which to discuss the feature, for the following reasons:
33+
34+
- Bugsnag has an internal roadmap of things to work on. We might have already planned to
35+
work on your suggested feature.
36+
- We might disagree about whether the addition is worthwhile or not.
37+
- We might agree that the addition is worthwhile but disagree with the implementation.
38+
39+
That said, we have had some tremendous contributions from the community in the past,
40+
so use your best judgement. What we want to avoid here is anybody feeling like they’ve
41+
wasted their time!
42+
43+
## Releases
44+
45+
To start a release:
46+
47+
- decide on a version number
48+
- create a new release branch from `next` with the version number in the branch name `git checkout -b release/vX.Y.Z`
49+
- review commits made to `next` since the last release
50+
- update `CHANGELOG.md` reflecting the above changes, release version, and release date and commit to your release branch
51+
- make a PR from your release branch to `main` entitled `Release vX.Y.Z`
52+
- get the release PR reviewed – all code changes should have been reviewed already, this should be a review of the integration of all changes to be shipped and the changelog
53+
54+
Once the release PR has been approved, merge the PR into `main`. You are now ready to make the release. Ensure you are logged in to npm and that you have access to publish the package.
55+
56+
- Make sure you are on the latest `main`.
57+
58+
- Bump the package version and push the new commit and tag:
59+
60+
```
61+
npm version <major|minor|patch>
62+
git push origin main
63+
git push --tags
64+
```
65+
66+
- Publish the new version to npm:
67+
68+
```
69+
npm publish
70+
```
71+
72+
Finally:
73+
74+
- create a release on GitHub https://github.com/bugsnag/vite-plugin-bugsnag/releases/new
75+
- Use the existing tag created during the version step above
76+
- copy the release notes from `CHANGELOG.md`
77+
- publish the release
78+
- update and push `next`:
79+
```
80+
git checkout next
81+
git merge main
82+
git push
83+
```

0 commit comments

Comments
 (0)