Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update publishing.md #1810

Merged
merged 3 commits into from
Jan 12, 2025
Merged

chore: Update publishing.md #1810

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0243759
Update publishing.md
alimpens Jan 10, 2025
c9f9a4d
Update docs
alimpens Jan 10, 2025
a3f4595
Add period
alimpens Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion documentation/publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,17 @@ This will cause a major version bump in both packages on release and add its des
```

2. This triggers a GitHub Action, which creates a release PR.
Review and approve this PR, then merge it – no need to wait for the checks.
Review this PR and make sure to check the changelogs for the different packages.
A commit might only be a breaking change for one package, but it will be marked as breaking for all affected packages.

Note: Release Please uses the PR description to create the GitHub release notes.
When you update a changelog, be sure to update both CHANGELOG.md and the PR description.

Approve the PR, then merge it – no need to wait for the checks.

The same Action will then publish the release to npm and GitHub.
It also deploys the released version to our main Storybook environment.

3. When complete, the Action adds a new release commit to `main`.
Locally merge this commit back into `develop` and push it to the remote:

Expand Down
Loading