Module re_build_tools::git

Situations to consider regarding git

Using the published crate

The published crate carries its version around, which in turns gives us the git tag, which makes the commit hash irrelevant. We still need to compute something so that we can actually build, but that value will be ignored when the crate is built by the end user anyhow.

Working directly within the workspace

When working within the workspace, we can simply try and call git and we’re done.

Using an unpublished crate (e.g. path = "…" or git = "…" or [patch.crates-io])

In these cases we may or may not have access to the workspace (e.g. a path = … import likely will, while a crate patch won’t).

This is not an issue however, as we can simply try and see what we get. If we manage to compute a commit hash, great, otherwise we still have the crate version to fallback on.

Functions

• git_branch
  Get the current git branch name
• git_commit_hash
  Get the full commit hash
• git_commit_short_hash
  Get the first 7 characters of the commit hash
• git_path 🔒
  From https://git-scm.com/docs/git-rev-parse:
• parse_branch_from_github_ref 🔒
• rebuild_if_branch_or_commit_changes