Skip to content

Commit 73e4b6e

Browse files
chore(readme): add beta publishing section (#475)
1 parent 3a1a810 commit 73e4b6e

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

.changeset/mean-tools-hammer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@stackoverflow/stacks-editor": patch
3+
---
4+
5+
Add beta publishing information to README

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,20 @@ We use [changesets](https://github.com/changesets/changesets) to automatize the
9898
_The release github workflow only run if the CI workflow (running linter, formatter and tests) is successful: CI is blocking accidental releases_.
9999

100100
_Despite using changesets to communicate the intent of creating releases in a more explicit way, we still follow [conventional commits standards](https://www.conventionalcommits.org/en/v1.0.0/) for keeping our git history easily parseable by the human eye._
101+
102+
### Beta publishing
103+
104+
We use Changesets in prerelease mode to manage publishing to the beta branch. For more information, please refer to the official [Changesets prerelease documentation](https://github.com/changesets/changesets/blob/main/docs/prereleases.md).
105+
106+
To prepare a beta release, follow these steps:
107+
108+
1. Create a pull request (PR) targeting the beta branch.
109+
110+
2. Ensure your PR includes a changeset.
111+
112+
3. Merging the PR will trigger the release-beta workflow. This workflow creates or updates a chore(new-beta-release) PR.
113+
114+
4. To cut a new beta release, merge the chore(new-beta-release) PR and wait for the `Release Beta` workflow to complete.
115+
116+
Consumers can install the beta package by targeting the beta tag:
117+
`npm install @stackoverflow/stacks-editor@beta`

0 commit comments

Comments
 (0)