honeymoose/angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: edit golden file error description (#34871)

Browse Source 
PR Close #34871
This commit is contained in:
Judy Bogart 2020-01-20 08:58:36 -08:00 committed by Matias Niemelä
parent 39ec188003
commit 5b77e67dff
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/PUBLIC_API.md
View File

@ -47,10 +47,11 @@ Our peer dependencies (such as TypeScript, Zone.js, or RxJS) are not considered
<a name="golden-files"></a> <a name="golden-files"></a>
## Golden files ## Golden files
Angular tracks the status of the public API in *golden files*. These files are stored in [tools/public_api_guard/](../tools/public_api_guard) and are maintained with a tool called [TS API Guardian](https://www.npmjs.com/package/ts-api-guardian).
If you modify any part of a public API in one of the supported public packages, you must update the golden files that track the public API surface. Angular tracks the status of the public API in a *golden file*, maintained with a tool called the *public API guard*.
If the golden files are not updated correctly, our test suite will detect the problem and the PR will fail to pass the tests. If you modify any part of a public API in one of the supported public packages, the PR can fail a test in CI with an error message that instructs you to accept the golden file.
In such cases, a test error message will provide instructions for a command that updates the golden files.
The public API guard provides a Bazel target that updates the current status of a given package. If you add to or modify the public API in any way, you must use [yarn](https://yarnpkg.com/) to execute the Bazel target in your terminal shell of choice (a recent version of `bash` is recommended).
```shell ```shell
yarn bazel run //tools/public_api_guard:<modified_package>_api.accept yarn bazel run //tools/public_api_guard:<modified_package>_api.accept