[skip changelog] Adjust link exclusions for project's protoc-gen-doc version#3225
Open
per1234 wants to merge 1 commit into
Open
[skip changelog] Adjust link exclusions for project's protoc-gen-doc version#3225per1234 wants to merge 1 commit into
per1234 wants to merge 1 commit into
Conversation
…version Documentation of the Protocol Buffers interface is automatically generated from the project source code. Unfortunately the protoc-gen-doc documentation generator tool produces some broken links. These cause the project infrastructure's link checker to fail: ``` ERROR: 2 dead links found in ./docs/rpc/commands.md ! [✖] #google.protobuf.Any → Status: 404 [✖] #google.rpc.Status → Status: 404 ``` It will not be feasible to fix these links, so the only available resolution for those link check failures is to configure exclusions. The previous exclusions were tailored to the links generated by the modern version of protoc-gen-doc. It turns out that the project infrastructure has an unfortunate design where management of this tool dependency is only done in the GitHub Actions workflows. This means that when the documentation generation is performed locally by a contributor, a different version of protoc-gen-doc may be used than that used by the CI system. The outdated version of protoc-gen-doc installed by the Github Actions workflow generates links with different fragment ID format than the modern version of the tool. That resulted in exclusions that caused the link check to pass locally, but fail in the CI runs. The link checker exclusions are hereby updated to match the links generated by the outdated version of protoc-gen-doc used by the project's GitHub Actions workflows.
per1234
added
topic: documentation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Bug fix
What is the current behavior?
Documentation of the Protocol Buffers interface is automatically generated from the project source code.
Unfortunately the protoc-gen-doc documentation generator tool produces some broken links. These cause the project infrastructure's link checker to fail:
It will not be feasible to fix these links, so the only available resolution for those link check failures is to configure exclusions.
The previous exclusions (#3221) were tailored to the links generated by the modern version of protoc-gen-doc. It turns out that the project infrastructure has an unfortunate design where management of this tool dependency is only done in the GitHub Actions workflows:
arduino-cli/.github/workflows/check-markdown-task.yml
Lines 122 to 123 in 5e8e4a3
This means that when the documentation generation is performed locally by a contributor, a different version of protoc-gen-doc may be used than that used by the CI system. The outdated version of protoc-gen-doc installed by the Github Actions workflow generates links with different fragment ID format than the modern version of the tool. That resulted in exclusions that caused the link check to pass locally, but fail in the CI runs.
What is the new behavior?
The link checker exclusions are updated to match the links generated by the outdated version of protoc-gen-doc used by the project's GitHub Actions workflows.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.