Skip to content

build(api-markdown-documenter): Simplify API-Extractor setup #24800

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

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Jun 9, 2025

This package is versioned and published independently from the rest of the repo. It was previously set up to use our shared base API-Extractor configs, which are configured for packages in release groups that version/publish many packages together.

Specific changes:

  • Don't extend shared config
  • Remove "lint" config (unused and unneeded)
  • Restore rollup generation
  • Fix /beta export path
  • Remove alpha report (this package has no alpha APIs nor export)

@Josmithr Josmithr requested review from jason-ha, a team and Copilot June 9, 2025 22:17
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR simplifies the API-Extractor setup for the api-markdown-documenter package so that it can be versioned and published independently.

  • Removed shared configuration extend and inlined API-Extractor configuration
  • Updated export type paths in package.json to better reflect the package name and fixed the /beta path
  • Removed the obsolete api-extractor-lint.json file

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
tools/api-markdown-documenter/package.json Updated exports to use more descriptive type paths
tools/api-markdown-documenter/api-extractor.json Removed shared config extend and added inline API-Extractor settings
tools/api-markdown-documenter/api-extractor-lint.json Removed obsolete lint configuration file

@github-actions github-actions bot added public api change Changes to a public API base: main PRs targeted against main branch labels Jun 9, 2025
Copy link
Contributor

@WayneFerrao WayneFerrao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple comments but looks good! :)

@Josmithr Josmithr requested a review from WayneFerrao June 9, 2025 23:53
"reportFileName": "<unscopedPackageName>",
"reportFolder": "<projectFolder>/api-report/",
"reportTempFolder": "<projectFolder>/_api-extractor-temp/",
"reportVariants": ["public", "beta"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where's @Alpha API document covering?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This package doesn't have any alpha APIs, so I removed the alpha report. It can be re-added as needed later.

Copy link
Contributor

@chentong7 chentong7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gogogo

Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  222981 links
    1707 destination URLs
    1939 URLs ignored
       0 warnings
       0 errors


@Josmithr Josmithr merged commit d091a68 into microsoft:main Jun 10, 2025
34 checks passed
@Josmithr Josmithr deleted the api-markdown-documenter/simplify-api-extractor-setup branch June 10, 2025 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
base: main PRs targeted against main branch public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants