Skip to content

fix report summary git url#64

Merged
machshev merged 2 commits intolowRISC:masterfrom
machshev:report-fixes-more
Nov 21, 2025
Merged

fix report summary git url#64
machshev merged 2 commits intolowRISC:masterfrom
machshev:report-fixes-more

Conversation

@machshev
Copy link
Copy Markdown
Collaborator

@machshev machshev commented Nov 20, 2025

The git commit link is broken on the summary page. This is now fixed with this PR.

  • Add git utility functions to get direct access to git commit hash
  • Fix github link on summary page

Fixes: #62

@machshev machshev force-pushed the report-fixes-more branch 2 times, most recently from f9feb91 to e14b489 Compare November 20, 2025 15:24
@machshev machshev changed the title Report fixes more fix report summary git url Nov 20, 2025
@machshev machshev marked this pull request as ready for review November 20, 2025 15:29
The current method for getting the git commit hash is to evaluate git
commands as part of hjson wildcard substitution. Presumably as a means
of making it more generic and supporting other version control systems.

However the opentitan HJSON builds up a markdown string containing a URL
link to github. Then DVSim parses that string with a regex. Which
couples the somewhat generic mechanism to an exact implementation.

This commit adds some generic git utility functions to work directly
with git from within DVSim and bypass HJSON calculated values. If we are
going to be calling Git, I'd rather do that directly from DVSim, rather
than some uncontrolled system call eval in HJSON. If we need to add
flexibility to support different systems then we can add that in the
future using a plugin system in DVSim and declaratively switching
between version control system (i.e. git) and hosting solution (i.e.
github) in the HJSON if required.

The current solution is highly coupled and doesn't allow for extension.
This solution is still git/github specific, but adds scope for later
extension if required. It also removes the dependence on one more eval
in the OpenTitan HJSON.

Signed-off-by: James McCorrie <james.mccorrie@lowrisc.org>
Signed-off-by: James McCorrie <james.mccorrie@lowrisc.org>
Copy link
Copy Markdown

@martin-velay martin-velay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but I am not a Python expert. As long as it has been tested and is an improvement I happy to approve it

@machshev machshev added this pull request to the merge queue Nov 21, 2025
Merged via the queue into lowRISC:master with commit 835926b Nov 21, 2025
6 checks passed
@machshev machshev deleted the report-fixes-more branch November 21, 2025 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix the github link on the summary page

2 participants