doc: warn about gzip timestamps (#979)

bazel-contrib · Nov 4, 2024 · f7fb4a9 · f7fb4a9
1 parent 250c835
commit f7fb4a9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/tar.md b/docs/tar.md
diff --git a/lib/tar.bzl b/lib/tar.bzl
@@ -15,6 +15,13 @@ We also provide full control for tar'ring binaries including their runfiles.
 The `tar` binary is hermetic and fully statically-linked.
 It is fetched as a toolchain from https://github.com/aspect-build/bsdtar-prebuilt.
 
+## Important Note
+
+When using `compress = "gzip"` its important to disable the non-deterministic time header by providing the `--options=gzip:!timestamp` option.
+
+See: https://datatracker.ietf.org/doc/html/rfc1952#page-5
+See: https://github.com/bazel-contrib/bazel-lib/issues/783
+
 ## Examples
 
 See the [`tar` tests](/lib/tests/tar/BUILD.bazel) for examples of usage.