Semantic release setup for beta branch #205
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #174
This change adds the necessary changes to
package.json
and.github/workflows/release.yml
for triggering beta releases on GitHub and to NPM whenever a PR is merged to abeta
branch. (see xmtp-js for working reference)This also change also adds CONTRIBUTING markdown following the example from xmtp-js, with one added section for Pre-release instructions. Markdown links to the documentation on pre-release workflows from semantic-release.
After this change is merged to
main
we can generate the newbeta
protected branch, and PRs merged targetingbeta
will create a beta release on NPM going forward.We can follow the xmtp-js model for keeping our
beta
branch up to date withmain
, and mergingbeta
branch intomain
when pre-release features have been sufficiently tested.main
=>beta
xmtp-js#500A section was added for advising when to target
beta
branch versusmain
branch in order to minimize work keep branches in sync when possible. Feedback welcomed: 64fa04e#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R54-R56