diff --git a/.github/workflows/Build and Publish.yml b/.github/workflows/Build and Publish.yml index e08305a..9a592c4 100644 --- a/.github/workflows/Build and Publish.yml +++ b/.github/workflows/Build and Publish.yml @@ -8,14 +8,14 @@ name: "Build and Publish" # Release Workflow ( Beta --> Production ) -# 1 - Create a new branch including the target release version ie `beta-0.5.6` -# 2 - Update the package.json version tag to match, and push release to the `beta-0.5.6` branch. This will trigger a npm release with the beta tag, and npm version set to `0.5.6-beta.0`. -# 3 - As updates are made to the beta branch, npm beta releases will be created. -# 4 - Once the release is complete, and ready for latest/production release, create a pull request to merge the changes into the `latest` branch. -# 5 - After reviews are complete, merge the pull request -# 6 - For the latest/production release, the workflow must be manually kicked off / started from Actions --> Build and Publish -# 7 - Delete beta branch - +# 1 - Determine what the target version will be for the final release and update the package.json version number ( ie `0.5.6`) +# 2 - Create a new branch including the target release version ie `beta-0.5.6` +# 3 - Commit the updated package.json to the new beta branch. This will trigger a npm release with the beta tag, and npm version set to `0.5.6-beta.0`. +# 4 - As updates are made to the beta branch, npm beta releases will be created. +# 5 - Once the release is complete, and ready for latest/production release, create a pull request to merge the changes into the `latest` branch. +# 6 - After reviews are complete, merge the pull request +# 7 - For the latest/production release, the workflow must be manually kicked off / started from Actions --> Build and Publish +# 8 - Delete beta branch on: push: