You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have a quick guide available to get you up and running with changesets [here](https://github.com/changesets/changesets/blob/main/docs/intro-to-using-changesets.md)
8
+
9
+
## How to use changesets
10
+
11
+
### Adding a changeset
12
+
13
+
When you're going to make changes to this package, you should run:
14
+
15
+
```bash
16
+
pnpm changeset
17
+
```
18
+
19
+
to add a changeset. This command will ask you a few questions, and then add a changeset file.
20
+
21
+
### Releasing
22
+
23
+
When you want to release, you should run:
24
+
25
+
```bash
26
+
pnpm changeset version
27
+
```
28
+
29
+
to version your packages, and then run:
30
+
31
+
```bash
32
+
pnpm changeset publish
33
+
```
34
+
35
+
to publish the packages.
36
+
37
+
### Release Process
38
+
39
+
This project uses automated releases through GitHub Actions. The release process works as follows:
40
+
41
+
1.**Create a changeset**: When you make changes, run `pnpm changeset` to document your changes
42
+
2.**Automatic versioning**: When changesets are merged to main, a PR is automatically created to bump versions
43
+
3.**Automatic release**: When the version PR is merged, the release workflow automatically:
44
+
- Builds for all platforms (Windows, macOS, Linux, Android)
45
+
- Creates a GitHub release with detailed notes
46
+
- Publishes artifacts
47
+
- Creates a release branch for hotfixes
48
+
49
+
### Manual Release
50
+
51
+
If you need to force a release, you can:
52
+
53
+
1. Go to the Actions tab in GitHub
54
+
2. Run the "Main Release" workflow manually
55
+
3. Choose your release type and options
56
+
57
+
### Hotfix Process
58
+
59
+
For urgent fixes:
60
+
61
+
1. Go to the Actions tab in GitHub
62
+
2. Run the "Hotfix Release" workflow
63
+
3. Specify the base version and hotfix description
64
+
4. A hotfix branch will be created automatically
65
+
66
+
## Release Types
67
+
68
+
-**patch**: Bug fixes and minor improvements
69
+
-**minor**: New features (backward compatible)
70
+
-**major**: Breaking changes
71
+
72
+
## Best Practices
73
+
74
+
1.**Always create changesets** for any changes that affect users
75
+
2.**Use clear, descriptive messages** in your changesets
76
+
3.**Mark breaking changes** with `!` or `BREAKING CHANGE:`
77
+
4.**Test thoroughly** before creating a changeset
78
+
5.**Review changeset PRs** carefully before merging
79
+
80
+
## Troubleshooting
81
+
82
+
If you encounter issues:
83
+
84
+
1. Check the GitHub Actions logs for detailed error messages
85
+
2. Ensure all secrets are properly configured
86
+
3. Verify that the changeset format is correct
87
+
4. Check that version numbers are valid semantic versions
0 commit comments