Developer Connect
https://github.com/pivotal-cf/docs-book-devconnect
The book repo uses these branches:
-
edge builds from the master content branch in this repo. Pipeline here.
-
master builds from the published content branches in this repo. Pipeline here.
All documentation for the next unreleased version of Developer Connect is in master
.
Always make changes you want carried forward in the master branch. This includes:
- Unreleased features
- Doc bug fixes
- Doc reorganization or enhancement
Branch Name | Use for… |
---|---|
master (current work) | v0.1 (staged here: http://docs-pcf-staging.cfapps.io/developer-connect/0-alpha/ |
When the latest alpha version is ready to publish, merge the master branch into an alpha branch. Keep all the alpha versions of the release notes stacked in the Release Notes for Pivotal Developer Connect page.
- Always cherry-pick any changes to live branches into master if you want those changes carried forward.
- If necessary, immediately cherry-pick/copy changes from master that you want to push immediately to production into the appropriate live branch above."
We need to decide on product name short forms:
Term or product name | Notes |
---|---|
Developer Connect | product_full , the longest name |
Production Pipeline
All live branches build to the cf-services > developer-connnect pipeline,
and are manually pushed to production as needed: Production pipeline.
-
Make changes in the first branch (usually
master
), commit them, and then push them to the repo. -
Copy part of the SHA for the above commit. To find this, you can do a
git log
, or look at the list of commits in the github repo. -
Checkout the second branch, where you want to copy the changes you made in the first branch.
-
Run this command, using the SHA snippet you copied above:
git cherry-pick <SHA_SNIPPET>
For example:git cherry-pick 5dc22fe00
Do the cherry-pick immediately to lessen the chances of conflicts. Otherwise, you may need to resolve conflicts in order to complete the cherry-pick.
-
Do a
git push
after the cherry-pick is complete.