From ad274d4fa42647a65e0bec7bc26a89309199c500 Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Tue, 13 Oct 2020 19:10:39 -0700 Subject: [PATCH] update preview-openapi-changes documentation (#16022) * update preview-openapi-changes documentation * clarify formatting and that bin dir should exist locally --- script/README.md | 8 ++++++++ script/preview-openapi-changes | 4 +++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/script/README.md b/script/README.md index c0127ee9bf4e..c2ee1b32fa0c 100644 --- a/script/README.md +++ b/script/README.md @@ -307,7 +307,15 @@ This script is run as a git precommit hook (installed by husky after npm install ### [`preview-openapi-changes`](preview-openapi-changes) +This script stitches and unstitches the `github/github` OpenAPI description via `rest-api-operations` to produce a local preview in docs-internal. +`github`, `rest-api-operations`, and `docs-internal` must share a parent directory locally. + +You must bootstrap `github` for this script to work. To check if you need to bootstrap, check if the `bin` directory in `github` exists locally. If it does not exist, run `./script/bootstrap` from the `github` directory. + +To stitch the repos together and do an npm build, pass the `stitch` argument. + +To unstitch the repos and revert them to their pre-stitched state, pass the `unstitch` argument. --- diff --git a/script/preview-openapi-changes b/script/preview-openapi-changes index 626771e2de6b..7f845f054b8c 100755 --- a/script/preview-openapi-changes +++ b/script/preview-openapi-changes @@ -1,6 +1,8 @@ #!/bin/bash -# Stitches and unstitches the github/github OpenAPI description via rest-api-operations to produce a local preview in docs-internal. This script should be placed in the directory that contains all three repos. +# Stitches and unstitches the github/github OpenAPI description via rest-api-operations to produce a local preview in docs-internal. +# `github`, `rest-api-operations`, and `docs-internal` must share a parent directory locally. +# You must bootstrap `github` for this script to work. To check if you need to bootstrap, check if the `bin` directory in `github` exists. If it does not exist, run `./script/bootstrap` from the `github` directory. # Options: # stitch: stitches the repos together and does the npm builds