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: use a gitflow-like workflow for the project #4416

Merged
merged 2 commits into from Aug 12, 2019

Conversation

@sodatea
Copy link
Member

commented Aug 9, 2019

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. master is for the latest dist-tag version on npm, and next for next dist-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 next branch so that users can preview documentation for the new features.

In the past, the website is deployed from the docs branch. It seems not so obvious for many users. Many documentation PRs are targeting the dev branch. So I now explicitly clarified this in the contributing guide and PR template. Also, the target branch is changed to master or next so 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.org deployed from v3 branch).

@NataliaTepluhina
Copy link
Contributor

left a 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.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
Update .github/CONTRIBUTING.md
Co-Authored-By: Natalia Tepluhina <NataliaTepluhina@users.noreply.github.com>

@sodatea sodatea merged commit 6918792 into vuejs:dev Aug 12, 2019

7 checks passed

ci/circleci: cli-ui Your tests passed on CircleCI!
Details
ci/circleci: group-1 Your tests passed on CircleCI!
Details
ci/circleci: group-2 Your tests passed on CircleCI!
Details
ci/circleci: group-3 Your tests passed on CircleCI!
Details
ci/circleci: group-4 Your tests passed on CircleCI!
Details
ci/circleci: install Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details

@sodatea sodatea deleted the sodatea:contribution-guide branch Aug 12, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.