Skip to content

Commit ad274d4

Browse files
authored
update preview-openapi-changes documentation (#16022)
* update preview-openapi-changes documentation * clarify formatting and that bin dir should exist locally
1 parent ac2d8f0 commit ad274d4

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

script/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,15 @@ This script is run as a git precommit hook (installed by husky after npm install
307307

308308
### [`preview-openapi-changes`](preview-openapi-changes)
309309

310+
This script stitches and unstitches the `github/github` OpenAPI description via `rest-api-operations` to produce a local preview in docs-internal.
310311

312+
`github`, `rest-api-operations`, and `docs-internal` must share a parent directory locally.
313+
314+
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.
315+
316+
To stitch the repos together and do an npm build, pass the `stitch` argument.
317+
318+
To unstitch the repos and revert them to their pre-stitched state, pass the `unstitch` argument.
311319

312320
---
313321

script/preview-openapi-changes

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
#!/bin/bash
22

3-
# 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.
3+
# Stitches and unstitches the github/github OpenAPI description via rest-api-operations to produce a local preview in docs-internal.
4+
# `github`, `rest-api-operations`, and `docs-internal` must share a parent directory locally.
5+
# 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.
46

57
# Options:
68
# stitch: stitches the repos together and does the npm builds

0 commit comments

Comments
 (0)