Use version tag, not SHA, in OpenBolt generated note#342
Merged
corporate-gadfly merged 1 commit intoJun 18, 2026
Merged
Conversation
OpenBolt's 'generated from' note showed the resolved commit SHA while OpenVox and OpenFact show the clean version tag. Pass PuppetReferences.version_commit (the pinned tag) to generated_note instead of @commit (the SHA from Repo#checkout), matching the other collections. Closes OpenVoxProject#336 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
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.
Problem
The "generated from" note on the OpenBolt generated reference pages showed the
upstream commit SHA instead of the clean version tag, unlike OpenVox and
OpenFact which show the tag:
Fix
lib/puppet_references/openbolt/docs.rbpassed@commit(the resolved SHA fromRepo#checkout) into the note. OpenVox/OpenFact instead use the pinned versiontag held in
PuppetReferences.version_commit. This change makes OpenBolt matchthem.
PuppetReferences.version_commitis set inbuild_openbolt_referencesbeforeDocs.newruns, so it holds the pinned tag.Verification
Built the references locally with the pinned version:
bundle exec rake references:openbolt INSTALLPATH=docsThe generated note now reads the version tag instead of the SHA:
ruby -candrubocopboth pass on the changed file.Closes #336