Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore:(docs) Update API Extractor file #31651

Merged
merged 5 commits into from
Jun 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/react-v9/contributing/api-extractor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### What is API Extractor?
Hotell marked this conversation as resolved.
Show resolved Hide resolved
Hotell marked this conversation as resolved.
Show resolved Hide resolved
mltejera marked this conversation as resolved.
Show resolved Hide resolved

[API Extractor](https://api-extractor.com/) generates an api.md file containing the public API for a package. `@fluentui/react` and related packages as well as `@fluentui/web-components` use API Extractor to ensure that API changes must be reviewed before being merged into master. (`@fluentui/react-northstar` and related packages do not use API Extractor as of writing.)

### Build Tasks

As part of a package's build process, the api-extractor task checks the package's public API with the package's auto-generated .api.md file. Be sure to commit the updates with your other changes

In PR builds, the task will fail if it detects missing API file updates.

To generate the API markdown file commit your changes, then run:

`yarn nx run <package-name>:build`

Commit and push the updated file.
Loading