Skip to content

Commit 5b77e67

Browse files
jbogarthydematsko
authored andcommitted
docs: edit golden file error description (angular#34871)
PR Close angular#34871
1 parent 39ec188 commit 5b77e67

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/PUBLIC_API.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,11 @@ Our peer dependencies (such as TypeScript, Zone.js, or RxJS) are not considered
4747
<a name="golden-files"></a>
4848

4949
## Golden files
50-
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).
51-
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.
52-
If the golden files are not updated correctly, our test suite will detect the problem and the PR will fail to pass the tests.
53-
In such cases, a test error message will provide instructions for a command that updates the golden files.
50+
51+
Angular tracks the status of the public API in a *golden file*, maintained with a tool called the *public API guard*.
52+
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.
53+
54+
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).
5455

5556
```shell
5657
yarn bazel run //tools/public_api_guard:<modified_package>_api.accept

0 commit comments

Comments
 (0)