-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Document git workspace SHA1 inclusion in C++ builds #2893
Copy link
Copy link
Closed as not planned
Labels
P3We're not considering working on this, but happy to review a PR. (No assignee)We're not considering working on this, but happy to review a PR. (No assignee)staleIssues or PRs that are stale (no activity for 30 days)Issues or PRs that are stale (no activity for 30 days)team-DocumentationDocumentation improvements that cannot be directly linked to other team labelsDocumentation improvements that cannot be directly linked to other team labelsteam-Rules-CPPIssues for C++ rulesIssues for C++ rulestype: documentation (cleanup)
Metadata
Metadata
Assignees
Labels
P3We're not considering working on this, but happy to review a PR. (No assignee)We're not considering working on this, but happy to review a PR. (No assignee)staleIssues or PRs that are stale (no activity for 30 days)Issues or PRs that are stale (no activity for 30 days)team-DocumentationDocumentation improvements that cannot be directly linked to other team labelsDocumentation improvements that cannot be directly linked to other team labelsteam-Rules-CPPIssues for C++ rulesIssues for C++ rulestype: documentation (cleanup)
Today, the best reference I can find for this is https://groups.google.com/forum/m/#!topic/bazel-discuss/9kqLmOq_m_U. The public docs (e.g. Build Encyclopedia) don't mention many of the details. For example
linkstampforcc_libraryis not documented, nor is--workspace_status_commandor the reference workspace status commandtools/buildstamp/get_workspace_status(which is not the default).We spent quite some time in the Envoy project during our Bazel conversion on getting a live git SHA1 since we were unaware of these mechanisms, mucking around with
genruleandrepository_rule. I think it would be beneficial to document this clearly, as this is a very core thing a build system needs to be able to do for any non-trivial project that does production releases.@mattklein123