Git reporting fixes#238
Merged
Merged
Conversation
Previously, gen_results() would crash with ValueError from GitPython when the project checkout had no remote named 'origin'. This only affected developer clones — CI checkouts always have 'origin' pointing at the canonical upstream — but the crash discarded the entire report after the simulation had already run. The Markdown revision line falls back to a plain commit-sha string with no link if a remote named 'origin' is not present. Signed-off-by: Harry Callahan <[email protected]>
The revision URL in a report points at a specific commit sha, but if the working tree had modifications when the simulation ran, that sha misrepresents the code that was actually tested. Append " (dirty)" to the revision line to make this explicit. The dirty state is captured at flow init time (alongside self.commit) so it reflects the checkout when the sim started, not when the report was generated. The suffix is applied on top of both dvsim's own revision formatting and any string supplied via revision_info from downstream HJSON (e.g. OpenTitan's common_project_cfg.hjson), and is idempotent so downstream revision commands can add their own marker without producing a doubled suffix. Signed-off-by: Harry Callahan <[email protected]>
machshev
approved these changes
Jul 20, 2026
machshev
left a comment
machshev
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @hcallahan-lowrisc
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
Fixes one minor papercut (for me), and adds a small reporting feature
Checklist
git commit -s), indicating acceptance of the CLA<type>[(<scope>)][!]: <description>)!or aBREAKING CHANGE:footer