gtristan commented on code in PR #87: URL: https://github.com/apache/buildstream-plugins/pull/87#discussion_r2070364298
########## src/buildstream_plugins/sources/git.py: ########## @@ -158,9 +166,33 @@ - `ref-not-in-track <https://docs.buildstream.build/master/buildstream.types.html#buildstream.types.CoreWarnings.REF_NOT_IN_TRACK>`_ - The provided ref was not found in the provided track in the element's git repository. -""" +Reporting `SourceInfo <https://docs.buildstream.build/master/buildstream.source.html#buildstream.source.SourceInfo>`_ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The git source reports the URL of the git repository as the *url*. + +Further, the git source reports the ``SourceInfoMedium.GIT`` *medium* and +the ``SourceVersionType.COMMIT`` *version_type*, for which it reports the git +commit sha as the *version*. + +Since the git source does not have a way to know what the release version +corresponds to the commit sha, the git source exposes the ``version`` configuration +attribute to allow explicit specification of the *guess_version*, for the toplevel Review Comment: FWIW, I tend to prefer this plugin in any of my projects, it doesn't require a third party plugins repo, and it doesn't require dulwich, and it does everything I need. It will be *nice* if the bst-plugins-community folks start upstreaming the nice features without using dulwich into this plugin, but otherwise, I really always reach for this one. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
