Skip to content

build: Disable ae-undocumented rule until api-extractor bug is fixed #18843

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Dec 15, 2023
Merged

build: Disable ae-undocumented rule until api-extractor bug is fixed #18843

merged 4 commits into from
Dec 15, 2023

Conversation

Josmithr
Copy link
Contributor

API-Extractor bug: microsoft/rushstack#3462

@Josmithr Josmithr requested review from a team as code owners December 14, 2023 22:28
@github-actions github-actions bot added area: build Build related issues area: dds Issues related to distributed data structures area: dds: propertydds area: dds: sharedstring area: dds: tree area: dev experience Improving the experience of devs building on top of fluid area: driver Driver related issues area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: odsp-driver area: runtime Runtime related issues area: server Server related issues (routerlicious) area: tests Tests to add, test infrastructure improvements, etc labels Dec 14, 2023
@github-actions github-actions bot added the base: main PRs targeted against main branch label Dec 14, 2023
@Josmithr Josmithr mentioned this pull request Dec 14, 2023
Merged
@msfluid-bot
Copy link
Collaborator

msfluid-bot commented Dec 14, 2023 •
edited
Loading

⯅ @fluid-example/bundle-size-tests: +18 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 495.11 KB 495.11 KB ⯅ +4 Bytes
connectionState.js 680 Bytes 680 Bytes ■ No change
containerRuntime.js 283.22 KB 283.22 KB ■ No change
loader.js 177.47 KB 177.47 KB ⯅ +2 Bytes
map.js 89.88 KB 89.89 KB ⯅ +2 Bytes
matrix.js 189.16 KB 189.16 KB ⯅ +2 Bytes
odspDriver.js 98.29 KB 98.29 KB ⯅ +2 Bytes
odspPrefetchSnapshot.js 51.81 KB 51.82 KB ⯅ +2 Bytes
sharedString.js 206.94 KB 206.95 KB ⯅ +2 Bytes
sharedTree2.js 313.88 KB 313.88 KB ■ No change
Total Size 1.98 MB 1.98 MB ⯅ +18 Bytes

Baseline commit: 59526c7

Generated by 🚫 dangerJS against cfedca6

@Josmithr Josmithr requested a review from a team as a code owner December 15, 2023 00:38
@github-actions github-actions bot added the public api change Changes to a public API label Dec 15, 2023
@anthony-murphy
Copy link
Contributor

i have concerns about this. i think by default anything undocumented will end up being public by default, this seems like it would be easy to leak things into the public api by mistake

@Josmithr
Copy link
Contributor Author

Josmithr commented Dec 15, 2023 •
edited
Loading

i have concerns about this. i think by default anything undocumented will end up being public by default, this seems like it would be easy to leak things into the public api by mistake

No. undocumented is reported for anything missing the core "summary" part of the comment. Tags are not included in the check at all.

anthony-murphy
anthony-murphy approved these changes Dec 15, 2023
View reviewed changes
Copy link
Contributor

@anthony-murphy anthony-murphy left a comment

Choose a reason for hiding this comment

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

Thanks for the clarification!

@Josmithr Josmithr merged commit d9b53e6 into microsoft:main Dec 15, 2023
@Josmithr Josmithr deleted the api-extractor/disable-ae-undocumented branch December 15, 2023 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anthony-murphy anthony-murphy anthony-murphy approved these changes

Assignees
No one assigned
Labels
area: build Build related issues area: dds: propertydds area: dds: sharedstring area: dds: tree area: dds Issues related to distributed data structures area: dev experience Improving the experience of devs building on top of fluid area: driver Driver related issues area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: odsp-driver area: runtime Runtime related issues area: server Server related issues (routerlicious) area: tests Tests to add, test infrastructure improvements, etc base: main PRs targeted against main branch public api change Changes to a public API
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Josmithr @msfluid-bot @anthony-murphy