Uh oh!
There was an error while loading. Please reload this page.
fix: pin doctooldotnet checkout to an explicit ref in generate-readme.yml - #136
Closed
spbsoluble wants to merge 2 commits into
Closed
fix: pin doctooldotnet checkout to an explicit ref in generate-readme.yml#136spbsoluble wants to merge 2 commits into
spbsoluble wants to merge 2 commits into
Conversation
….yml The "Checkout doctool action" step checked out keyfactor/doctooldotnet with no ref, always running whatever is on its default branch. Every push to an integration repo silently picks up whatever doctool bugs landed since the last push, with no way to control or roll back the version in use. Keyfactor/akeyless-pam#11 hit this concretely: a known PamRenderer bug duplicates sections in docs/<type>.md and drops the Extension Mechanics/Configuration sections from README.md entirely. It's been manually reverted twice already in that repo because every subsequent push re-triggers the same regeneration. Add a doctool-ref input (default: current doctooldotnet main HEAD, so behavior is unchanged today) and pass it to the checkout step, so picking up a doctool fix is a deliberate version bump instead of an implicit side effect of the next push.
Keep doctooldotnet tracking main by default (today's actual behavior) instead of freezing it at a specific commit. The doctool-ref input stays available for any caller that wants to pin to a known-good commit/tag for stability, but that's now opt-in rather than forced.
spbsoluble
commented
Aug 7, 2026
ContributorAuthor
Closing — this doesn't fix anything. The checkout already tracks doctooldotnet's default branch, and once Keyfactor/doctooldotnet#25 merges to main, this workflow picks it up automatically with no changes here needed. The actual fix belongs entirely in that repo. |
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 freeto 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.
Summary
generate-readme.yml's "Checkout doctool action" step checks outkeyfactor/doctooldotnetwith noref:, so it implicitly runs whatever is currently on that repo's default branch (main). That's the correct behavior — this repo should always pick up the latest doctool — but it was implicit, which made it easy to conflate "doctool is broken" with "our workflow is broken" when main regresses.This PR doesn't change that behavior. It adds an explicit
doctool-refinput, defaulting to'main', and passes it through to the checkout step'sref:. Functionally identical to today. The difference is that any caller who does need to pin to a specific commit/tag for stability (e.g. while waiting on a doctool fix to land) now has a one-line, reviewable way to do it, instead of that only being possible by editing this shared workflow.Context:
Keyfactor/akeyless-pamPR #11 hit a realdoctooldotnetmainregression (PamRendererduplicates sections indocs/<type>.mdand drops "Extension Mechanics"/"Configuration" fromREADME.md— seeKeyfactor/doctooldotnet#25for the fix, not yet merged). That's adoctooldotnetbug to fix in that repo; this PR just makes it possible to work around such regressions here without forking the workflow.Test plan
main) preserves current behavior exactly — no caller (starter.yml) changes required