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
Copy file name to clipboardExpand all lines: README.md
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ Thanks for being here! You're contributing to a digital public good that will al
59
59
60
60
We use changesets to manage releases: [`github.com/changesets`](https://github.com/changesets/changesets)
61
61
62
-
A changeset is a description of batch of changes, coupled with semver information.
62
+
A changeset is a file with a short note about something that has changed. At release time, version numbers are bumped and all changeset notes are compiled into a CHANGELOG.md.
63
63
64
64
### Adding a change
65
65
@@ -69,21 +69,18 @@ When submitting a PR against this repo, include a changeset to describe your wor
69
69
pnpm changeset
70
70
```
71
71
72
-
For example changeset notes, look in the `.changesets` folder.
72
+
A good changeset is usually a single-sentence explanation of a change, suitable for a technical user not familiar with this repository. We do not recommend using AI to generate changesets.
73
73
74
74
### Releasing
75
75
76
-
New releases will be published to npm automatically when merging into main.
76
+
When merging into main, new packages will be published to npm and new images built to docker hub.
77
77
78
78
Before merging to main, check out the release branch locally and run the following steps:
79
79
80
80
1. Run `pnpm changeset version` from root to bump versions
81
+
1. Check that the updated changelogs look correct.
81
82
1. Run `pnpm install`
82
-
1. Commit the new version numbers
83
-
1. Run `pnpm changeset tag` to generate tags
84
-
1. Push tags `git push --tags`
85
-
86
-
Remember tags may need updating if commits come in after the tags are first generated.
83
+
1. Commit and push the new version numbers and lockfile
0 commit comments