refactor(api-markdown-documenter): Add {@link} tag reference validation to linter
#22224
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…github.com/Josmithr/FluidFramework into api-markdown-documenter/load-model-cleanup
…rkdown-documenter/link-linter
…github.com/Josmithr/FluidFramework into api-markdown-documenter/inheritdoc-linting
…rkdown-documenter/link-linter
commit a674bcb Author: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com> Date: Thu Aug 15 17:09:07 2024 +0000 remove: Domain that was not intended to be checked in commit 3c92239 Merge: 8b209c8 2b0199d Author: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com> Date: Thu Aug 15 17:08:12 2024 +0000 Merge branch 'main' into api-markdown-documenter/inheritdoc-linting commit 2b0199d Author: Tony Murphy <anthony.murphy@microsoft.com> Date: Thu Aug 15 09:19:59 2024 -0700 MergeTree: Deprecate segmentGroups and ack on ISegment (microsoft#22212) The `SegmentGroupCollection` class, along with the `segmentGroups` property and `ack` function on segments, are not intended for external use. These elements will be removed in a future release for the following reasons: * There are no scenarios where they need to be used directly. * Using them directly will cause eventual consistency problems. * Upcoming features will require modifications to these mechanisms. commit 801bf2f Author: Alex Villarreal <716334+alexvy86@users.noreply.github.com> Date: Wed Aug 14 20:41:12 2024 -0500 Revert "refactor(ci): Remove redundant component detection task in server pipelines" (microsoft#22210) Reverts microsoft#22180. Turns out the extra component governance task is currently necessary for the NOTICE file generation to succeed. We're exploring if we can make that work with the auto-injected component governance tasks, but in the meantime we want this back. commit 8b209c8 Author: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com> Date: Thu Aug 15 00:30:01 2024 +0000 style: Newline commit dc38611 Author: Jason Hartman <jasonha@microsoft.com> Date: Wed Aug 14 16:45:31 2024 -0700 test(client): DataStore test type correctness (microsoft#22166) - Reduce need from `ContainerRuntime` to `IFluidParentContext` and rename appropriately - Use proper types for IFluidDataStoreFactory and IFluidDataStoreRegistry mocks. - remove extraneous `on` entries - add missing `type` entry - rename misspelled `baseLogger` entry - remove unnecessary `wrapContextForInnerChannel` use - drop `wrapContextForInnerChannel` export commit 3819442 Author: Zach Newton <znewton@microsoft.com> Date: Wed Aug 14 15:58:28 2024 -0700 server: add a couple doc comments (microsoft#22213) Missed adding some doc comments in microsoft#22109 commit 18b76b2 Author: Zach Newton <znewton@microsoft.com> Date: Wed Aug 14 14:59:13 2024 -0700 server: telemetry context header (microsoft#22109) Global TelemetryContext was implemented several major server versions ago. At the same time, the old `getCorrelationId` and `bindCorrelationId` method of tracking correlationId was deprecated. This PR removes usage of those methods, and also adds a new Telemetry Context header that can be extended to track other information for the lifetime of an API request. For the new `x-telemetry-context` header, the old `x-correlation-id` header will still be respected (for now) if `x-telemetry-context` header does not container `correlationId` property. BasicRestWrapper now takes in an optional `getTelemetryContextProperties` method, similar to how it takes a `getCorrelationId` method. This is used to generate telemetryContext header on outgoing requests from within R11s. `x-correlation-id` is still generated. - `enableGlobalTelemetryContext` config switched to `true` in code. Was already true in configs. - `bindCorrelationId` usage was removed from Gitrest, Historian, and Routerlicious Rest APIs, meaning `getCorrelationId` without `enableGlobalTelemetryContext: true` will not work anymore. I'm leaving the old `getCorrelationId` and `bindCorrelationId` methods in for 1 more release cycle out of abundance of caution, even though it has been deprecated for almost a year. commit ebf7ae2 Author: Alex Villarreal <716334+alexvy86@users.noreply.github.com> Date: Wed Aug 14 16:58:48 2024 -0500 refactor(ci): Update credscan suppressions to handle historian and gitrest (microsoft#22211) Follow up to microsoft#22179, addressing the same warning for the historian and gitrest pipelines (gitssh didn't even have warnings). The same test files for the same dependencies show up in the builds for routerlicious (server), historian, and gitrest, and the credscan file was hardcoding the full path for the routerlicious case. Using path "suffixes" is supported, so now those files are correctly skipped for all three pipelines.
Josmithr
commented
Aug 15, 2024
Josmithr
commented
Aug 15, 2024
| @@ -76,12 +85,12 @@ interface MutableLinterErrors { | |||
| * Errors found during linting. | |||
| */ | |||
| export interface LinterErrors { | |||
| // TODO: malformed tag errors | |||
⯅ @fluid-example/bundle-size-tests: +245 Bytes
Baseline commit: 56989e4 |
TommyBrosman
approved these changes
Aug 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up to #22150. Adds validation for
{@link}references within the model.