Include the commit hash in the sbws version

When we put the sbws version in the bandwidth file, we should include the git commit hash. That helps us tell dev versions apart.

changed milestone to %sbws: 1.1.x-final

added component::core tor/sbws milestone::sbws: 1.1.x-final points::1 priority::high resolution::fixed reviewer::ahf sbws-roadmap severity::major status::closed type::enhancement labels

See https://trac.torproject.org/projects/tor/ticket/30733#comment:21 for one time we wanted this feature.

Here's one way we could do this feature:

Add a software_commit key to the bandwidth file header. If git is installed at runtime (or install time), make the header value "git-(commit hash)". Here's how PrivCout does it in python: https://github.com/privcount/privcount/blob/master/privcount/protocol.py#L33

We should also show the git commit hash when we print the sbws version in the log.

We also wanted this change in this ticket: https://trac.torproject.org/projects/tor/ticket/30733#comment:48

It's going to be hard to diagnose sbws bugs without the git commit hash, because some sbws operators upgrade sbws from source. So I'm going to suggest that we add this ticket to the roadmap.

Trac:
Priority: Medium to High
Severity: Normal to Major
Milestone: sbws: 1.2.x-final to sbws: 1.1.x-final

Trac:
Keywords: N/A deleted, sbws-roadmap added

https://github.com/torproject/sbws/pull/370 (i already saw some typos after creating the PR, but well, if the code is fine i can fix them afterwards)

Trac:
Status: new to needs_review
Reviewer: N/A to ahf

Thinking it better, i might use setuptools_scm or just my own function cause this already created some confusion.

I think the PEP440 format is great. It's really useful to be able to work out which sbws versions are earlier or later, even when you only have a commit hash.

But I don't mind how it's implemented.

I think overall this looks good, but I added two questions in there :-)

Trac:
Status: needs_review to needs_information

i replied to the questions and added documentation

Looks good!

Trac:
Status: needs_information to merge_ready

Merged

Trac:
Status: merge_ready to closed
Resolution: N/A to fixed

Thanks for this change, it's really helpful for diagnosing issues. Great work!

closed

changed time estimate to 8h

mentioned in issue #33198 (moved)

mentioned in issue #33408 (moved)

mentioned in issue tpo/core/tor#33408 (closed)

moved to tpo/network-health/sbws#30899 (closed)

mentioned in issue tpo/network-health/sbws#33198 (closed)