gtristan commented on code in PR #87: URL: https://github.com/apache/buildstream-plugins/pull/87#discussion_r2072882582
########## 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: This is a duplicate thread from the one below, I didn't know `git` supports the git describe ref format (or that git would be able to even function equally with a git describe string as it does with a commit sha). Resolving this thread and leaving only one of these open. -- 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]
