chore: use a gitflow-like workflow for the project #4416
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
haoqunjiang
requested review from
yyx990803,
Akryum,
LinusBorg and
NataliaTepluhina
NataliaTepluhina
approved these changes
Aug 9, 2019
There was a problem hiding this comment.
Thank you for suggesting this change @sodatea! I can definitely see the confusion people have when creating documentation PRs, and I believe this change will make it easier.
I left a minor suggestion (mostly just a rewording) for the workflow description.
Co-Authored-By: Natalia Tepluhina <NataliaTepluhina@users.noreply.github.com>
This was referenced Oct 17, 2020
This was referenced Nov 17, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Now that we do v3 & v4 releases in parallel (even after v4 stable release, v3 will continue to receive bug fixes), I'd like to tweak the git workflow a little bit to make it easier.
So, inspired by Gitflow, I propose that we have two production-ready branches -
master&next.masteris for thelatestdist-tagversion on npm, andnextfornextdist-tag(pre-release versions). It's not only used for v4 betas, but we can also have prereleases for feature releases in the future.I've also set up Netlify to deploy https://next.cli.vuejs.org from the
nextbranch so that users can preview documentation for the new features.In the past, the website is deployed from the
docsbranch. It seems not so obvious for many users. Many documentation PRs are targeting thedevbranch. So I now explicitly clarified this in the contributing guide and PR template. Also, the target branch is changed tomasterornextso that the code and documentation are in sync, no longer need to cherry-pick & merge across multiple branches.Though our documentation currently covers features in both v3 & v4, with version-related notes, it may change over time. So I'd also like to set up version-specific documentation, deployed directly from the version archive branch (e.g.
v3.cli.vuejs.orgdeployed fromv3branch).