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.

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

chore(readme): update release process #352

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

Conversation

sean-perkins
Copy link
Collaborator

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally for affected output targets
  • Tests (npm test) were run locally and passed
  • Prettier (npm run prettier) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue URL:

What is the new behavior?

  • Updates the release workflow process to mention how the version is bumped and that you are responsible for committing the changes after the release workflow has completed.

Does this introduce a breaking change?

  • Yes
  • No

Other information

@sean-perkins sean-perkins marked this pull request as ready for review June 6, 2023 21:00
@sean-perkins sean-perkins requested review from a team as code owners June 6, 2023 21:00
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?

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.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants