Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ORT run details query should return more revision information #2082

Open
Etsija opened this issue Feb 21, 2025 · 3 comments
Open

ORT run details query should return more revision information #2082

Etsija opened this issue Feb 21, 2025 · 3 comments
Assignees
Labels
api Issues related to the API.

Comments

@Etsija
Copy link
Contributor

Etsija commented Feb 21, 2025

ORT runs have a "revision" string, which I believe currently just resolves to what the user has written to the create run form; in case the user leaves revision empty, it's also ean mpty string in the ORT run details query.

With #2036 we are correctly also handling the case of leaving the "revision" empty, and in that case, the default branch is used.

However we are missing important information from the UI about the non-resolved and resolved revisions.

I think we need two things from the ORT run details endpoint, to show them properly in the UI:

  • the non-resolved revision that was found (ie. EITHER what was input to the run creation form, OR the found default branch name in case the field was left empty in the form)
  • the resolved revision (ie. commit SHA)

I believe we could then even ditch the resolved configuration information from the ORT run details page if requested, and add this info instead, as I believe it is far more useful to the users to see which revision exactly was analyzed, rather than seeing which revision of the configuration provider was used.

@Etsija Etsija added the api Issues related to the API. label Feb 21, 2025
@mnonnenmacher
Copy link
Contributor

the non-resolved revision that was found (ie. EITHER what was input to the run creation form, OR the found default branch name in case the field was left empty in the form)

For this maybe the recently introduced code to use the default branch could be adapted to store the default branch name in the revision property of the run. If we want to keep the information that the run was triggered without providing a revision we would need a separate property, but I'm not sure if that is really required.

believe we could then even ditch the resolved configuration information from the ORT run details page if requested

I would prefer to keep it. It is important to know which version of the rules or other configuration files like license classifications were used.

@Etsija
Copy link
Contributor Author

Etsija commented Feb 21, 2025

I believe in addition to the default branch name we really would need to see the resolved revision (ie. the exact commit SHA) of the targeted repository as well.

@mnonnenmacher mnonnenmacher self-assigned this Feb 21, 2025
@mnonnenmacher
Copy link
Contributor

This is mostly fixed by #2163 but for storing the default branch name I will make a separate PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Issues related to the API.
Projects
None yet
Development

No branches or pull requests

2 participants