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

Jump to bottom

chore(readme): update release process #352

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(readme): update release process #352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@ This project uses [Volta](https://volta.sh/) to automatically manage what npm an

There is a manual workflow task called "Production Release" within the GitHub Actions workflows directory. We currently do not release all packages that have been changed at once. You will need to deploy each package (vue, react, angular) individually.

> Do not bump the package version before running the Github Action release. The release workflow will bump the version for you. You will be responsible for committing the version bump manually after the release workflow has completed.

You'll need to fill out a few bits of information when you submit the deploy workflow:
1. Which package should be published (Currently `vue`, `react`, or `angular`).
2. What version should be published.
3. What npm tag it should be published under (`next` or `latest`)
4. Any preid, like `alpha` or `rc`
5. After the release has been published, you will need to manually bump the version in the `package.json` and `package-lock.json` files and commit the change.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a hint/example/suggestion to use npm version --no-git-tag-version to do this to ensure everything gets bumped properly?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about having them create a tag as well? e.g. git tag -a @stencil/vue-output-target@0.8.6 -m "@stencil/vue-output-target v0.8.6" and have them push it to GH (git push origin @stencil/vue-output-target@0.8.6)?