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.
Summary
This PR adds the release workflow using Ship.js.
fixes #801
Release Workflow
Prepare: It will prepare a release pull-request which includes version bumping and changelog updates.
Review: Maintainers review the PR, probably updates some changelogs, approve and merge it.
Trigger: CI (in this case, GitHub Actions) is triggered, and it builds, and releases the package to NPM. It also creates a git tag and GitHub releases.
More about "Prepare" step
There are three ways to prepare release pull-request.
.github/workflows/shipjs-schedule-prepare.yml
, it will automatically prepare the pull-request every week.yarn run prepare
locally with the environment variable GITHUB_TOKEN..github/workflows/shipjs-manual-prepare.yml
, if maintainers of this repo adds a comment@shipjs prepare
to any comment, it will prepare a release pull-request. (← If you don't want this behavior, you can remove the workflow file.)Remaining Setup
This repo needs to have two environment variables for GitHub Actions:
GITHUB_TOKEN
: https://github.com/settings/tokens/newNPM_AUTH_TOKEN
: If your NPM account has 2FA enabled, you need to create "Automation" token.