summary refs log tree commit diff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorArnout Engelen <arnout@bzzt.net>2022-09-24 09:39:47 +0200
committerArnout Engelen <arnout@bzzt.net>2022-09-25 22:33:46 +0200
commit2018f92ef25a57c07b4c924476375948cf60164e (patch)
tree181e39800ce490b425853cdd44d24e05dbf4928b /.github/ISSUE_TEMPLATE
parentae1dc133ea5f1538d035af41e5ddbc2ebcb67b90 (diff)
Add issue template for unreproducible packages
It's nice to be able to easily create an issue for an unreproducibility,
but my additional motivation for creating this issue template is that it
makes it easier for non-maintainers to create issues that are correctly
tagged '8.topic: reproducible builds'.
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/unreproducible_package.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/unreproducible_package.md b/.github/ISSUE_TEMPLATE/unreproducible_package.md
new file mode 100644
index 0000000000000..749976dfbecdb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/unreproducible_package.md
@@ -0,0 +1,31 @@
+---
+name: Unreproducible package
+about: A package that does not produce a bit-by-bit reproducible result each time it is built
+title: ''
+labels: '0.kind: enhancement', '6.topic: reproducible builds'
+assignees: ''
+
+---
+
+Building this package twice does not produce the bit-by-bit identical result each time, making it harder to detect CI breaches. You can read more about this at https://reproducible-builds.org/ .
+
+Fixing bit-by-bit reproducibility also has additional advantages, such as avoiding hard-to-reproduce bugs, making content-addressed storage more effective and reducing rebuilds in such systems.
+
+### Steps To Reproduce
+
+```
+nix-build '<nixpkgs>' -A ... --check --keep-failed
+```
+
+You can use `diffoscope` to analyze the differences in the output of the two builds.
+
+To view the build log of the build that produced the artifact in the binary cache:
+
+```
+nix-store --read-log $(nix-instantiate '<nixpkgs>' -A ...)
+```
+
+### Additional context
+
+(please share the relevant fragment of the diffoscope output here,
+and any additional analysis you may have done)