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
This directory contains changeset files that track changes to the codebase. The changeset system is inspired by the JavaScript changesets tool but adapted for Python projects.
4
+
5
+
## How it works
6
+
7
+
1.**Creating a changeset**: When you make changes that should be included in the changelog, run:
8
+
```bash
9
+
python .changeset/scripts/changeset.py
10
+
# or use the wrapper script:
11
+
./changeset
12
+
```
13
+
14
+
This will prompt you to:
15
+
- Select the type of change (major, minor, or patch)
16
+
- Provide a description of the change
17
+
18
+
A markdown file will be created in this directory with a random name like `warm-chefs-sell.md`.
19
+
20
+
2.**Version bumping**: The GitHub Action will automatically:
21
+
- Detect changesets in PRs to main
22
+
- Create or update a "Version Packages" PR
23
+
- Bump the version based on the changesets
24
+
- Update the CHANGELOG.md
25
+
26
+
3.**Publishing**: When the "Version Packages" PR is merged:
27
+
- The package is automatically published to PyPI
28
+
- A GitHub release is created
29
+
- The changesets are archived
30
+
31
+
## Changeset format
32
+
33
+
Each changeset file looks like:
34
+
```markdown
35
+
---
36
+
"stagehand": patch
37
+
---
38
+
39
+
Fixed a bug in the browser automation logic
40
+
```
41
+
42
+
## Configuration
43
+
44
+
The changeset behavior is configured in `.changeset/config.json`:
45
+
-`baseBranch`: The branch to compare against (usually "main")
46
+
-`changeTypes`: Definitions for major, minor, and patch changes
47
+
-`package`: Package-specific configuration
48
+
49
+
## Best practices
50
+
51
+
1. Create a changeset for every user-facing change
52
+
2. Use clear, concise descriptions
53
+
3. Choose the appropriate change type:
54
+
-`patch`: Bug fixes and small improvements
55
+
-`minor`: New features that are backwards compatible
56
+
-`major`: Breaking changes
57
+
58
+
## Workflow
59
+
60
+
1. Make your code changes
61
+
2. Run `./changeset` to create a changeset
62
+
3. Commit both your code changes and the changeset file
63
+
4. Open a PR
64
+
5. The changeset will be processed when the PR is merged to main
0 commit comments