Skip to content

Commit 4de4e47

Browse files
authored
[docs] mb-pages -> publisher-production (mapbox#7787)
1 parent 4cc2a7d commit 4de4e47

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- Thanks for the PR! Feel free to add or remove items from the checklist. -->
44

5-
<!-- If your PR affects documentation relevant to the currently released version, please use `mb-pages` as the base branch. See https://github.com/mapbox/mapbox-gl-js/blob/master/docs/README.md#committing-and-publishing-documentation -->
5+
<!-- If your PR affects documentation relevant to the currently released version, please use `publisher-production` as the base branch. See https://github.com/mapbox/mapbox-gl-js/blob/master/docs/README.md#committing-and-publishing-documentation -->
66

77
- [ ] briefly describe the changes in this PR
88
- [ ] write tests for all new functionality

build/check-bundle-size.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ function getMergeBase() {
6666
// base branch.
6767
const head = process.env['CIRCLE_SHA1'];
6868
for (const sha of execSync(`git rev-list --max-count=10 ${head}`).toString().trim().split('\n')) {
69-
const base = execSync(`git branch -r --contains ${sha} origin/master origin/release-* origin/mb-pages`).toString().split('\n')[0].trim().replace(/^origin\//, '');
69+
const base = execSync(`git branch -r --contains ${sha} origin/master origin/release-* origin/publisher-production`).toString().split('\n')[0].trim().replace(/^origin\//, '');
7070
if (base) {
7171
return Promise.resolve(execSync(`git merge-base origin/${base} ${head}`).toString().trim());
7272
}

docs/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ The command will print the URL you can use to view the documentation.
4444

4545
## Committing and Publishing Documentation
4646

47-
The mapbox-gl-js repository has both `master` and `mb-pages` as active branches. The **`master` branch** is used for mainline code development: the next version of mapbox-gl-js will come from the code in this branch, and it may contain documentation and examples for APIs that are not yet part of a public release. The **`mb-pages` branch** is published to https://www.mapbox.com/mapbox-gl-js/ on any push to the branch. For the purposes of documentation changes, use these two branches as follows:
47+
The mapbox-gl-js repository has both `master` and `publisher-production` as active branches. The **`master` branch** is used for mainline code development: the next version of mapbox-gl-js will come from the code in this branch, and it may contain documentation and examples for APIs that are not yet part of a public release. The **`publisher-production` branch** is published to https://www.mapbox.com/mapbox-gl-js/ on any push to the branch. For the purposes of documentation changes, use these two branches as follows:
4848

49-
* If your changes are relevant to the **currently released version**, make them on `mb-pages`. Examples: correcting the API documentation for a released API, adding a new example that depends only on current APIs.
49+
* If your changes are relevant to the **currently released version**, make them on `publisher-production`. Examples: correcting the API documentation for a released API, adding a new example that depends only on current APIs.
5050
* If your changes depend on gl-js features **not in the currently released version**, make them on `master`. Examples: documenting or adding an example for a newly-added API.
5151

5252
When releasing, the release manager will:
5353

54-
* Merge `mb-pages` to `master`, ensuring that any accumulated changes in `mb-pages` propagate to `master`
54+
* Merge `publisher-production` to `master`, ensuring that any accumulated changes in `publisher-production` propagate to `master`
5555
* Make the release
56-
* Fast-forward `mb-pages` to the current `master`, ensuring that all accumulated changes are published to mapbox.com
56+
* Fast-forward `publisher-production` to the current `master`, ensuring that all accumulated changes are published to mapbox.com

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@
124124
"start-debug": "run-p build-token watch-css watch-dev start-server",
125125
"start-bench": "run-p build-token watch-benchmarks watch-style-benchmarks start-server",
126126
"build-docs": "documentation build --github --format json --config ./docs/documentation.yml --output docs/components/api.json src/index.js",
127-
"build": "run-s build-docs && batfish build # invoked by publisher when publishing docs on the mb-pages branch",
127+
"build": "run-s build-docs && batfish build # invoked by publisher when publishing docs on the publisher-production branch",
128128
"start-docs": "run-s build-prod-min build-css build-docs && DEPLOY_ENV=local batfish start",
129129
"lint": "eslint --cache --ignore-path .gitignore src test bench docs docs/pages/example/*.html debug/*.html",
130130
"lint-docs": "documentation lint src/index.js",
131131
"lint-css": "stylelint 'src/css/mapbox-gl.css'",
132-
"open-changed-examples": "git diff --name-only mb-pages HEAD -- docs/pages/example/*.html | awk '{print \"http://127.0.0.1:4000/mapbox-gl-js/example/\" substr($0,33,length($0)-37)}' | xargs open",
132+
"open-changed-examples": "git diff --name-only publisher-production HEAD -- docs/pages/example/*.html | awk '{print \"http://127.0.0.1:4000/mapbox-gl-js/example/\" substr($0,33,length($0)-37)}' | xargs open",
133133
"test": "run-s lint lint-css test-flow test-unit",
134134
"test-suite": "run-s test-render test-query",
135135
"test-suite-clean": "find test/integration/{render,query}-tests -mindepth 2 -type d -not \\( -exec test -e \"{}/style.json\" \\; \\) -print | xargs -t rm -r",

0 commit comments

Comments
 (0)