Repository navigation
CI: Update actions - #1360
Merged
Merged
CI: Update actions#1360
Conversation
Fenrirthviti
reviewed
Oct 2, 2026
Fenrirthviti
approved these changes
Oct 2, 2026
Fenrirthviti
left a comment
Fenrirthviti
left a comment
Member
There was a problem hiding this comment.
LGTM.
Alt text guidance seems to boil down to "describe the thing" and this looks fine.
Fenrirthviti
requested changes
Oct 2, 2026
Fenrirthviti
left a comment
Fenrirthviti
left a comment
Member
There was a problem hiding this comment.
Pending internal conversation on the OC contributors list in the readme.
Leaving a review comment to prevent accidental merge.
RytoEX
marked this pull request as draft
October 2, 2026 20:02
This is causing a name collision on category names when building header
links in the documentation. The "category" names are being registered in
get_fragment even though the header patterns for Events and Requests are:
* `## {} Events`
* `## {} Requests`
As a result, when processing Requests, the shared categories between
Events and Requests, such as "General" and "Config", end up with
"deduplicated" names for the header links such as:
* general-1-requests
* config-1-requests
This results in broken links in the Requests Table of Contents.
Since the categories themselves are not used to build links anywhere, we
can set the register param in those get_fragment(category) calls to
False and only register the requestType and eventType fragments.
Pin the action to the commit for v3.5.0. Also, update the config to ignore introduction.md because its links will always be broken as it is a partial file used to generate the complete documentation.
Member
Author
Per off-thread discussion, left the OC contributors lists as-is, but added alt text. |
RytoEX
marked this pull request as ready for review
October 2, 2026 21:29
Fenrirthviti
approved these changes
Oct 2, 2026
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
2 participants
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.
Description
Add alt text to images in README to avoid linter failure. @Warchamp7 happy to defer to you if you want to write more descriptive alt text.
@tt2468 may need to weigh in on the change to documentation generation, because I may have missed some nuance there.
Do not register "categories" as global fragments when generating documentation.
This is causing a name collision on category names when building header links in the documentation. The "category" names are being registered in get_fragment even though the header patterns for Events and Requests are:
## {} Events## {} RequestsAs a result, when processing Requests, the shared categories between Events and Requests, such as "General" and "Config", end up with "deduplicated" names for the header links such as:
This results in broken links in the Requests Table of Contents.
Since the categories themselves are not used to build links anywhere, we can set the register param in those get_fragment(category) calls to False and only register the requestType and eventType fragments.
Note: this looks like a missed change from 947f261.
Finally, update and pin nosborn/github-action-markdown-cli to v3.5.0 as originally intended now that all linter failures have been addressed.
Motivation and Context
Update CI actions. Address linter failures.
How Has This Been Tested?
Tested on my CI.
Types of changes
Checklist:
masteror arelease/*branch.