[Git][reproducible-builds/reproducible-website][master] First stab at documenting the JVM buildinfo format

[Arnout Engelen]

Arnout Engelen pushed to branch master at Reproducible Builds / reproducible-website


Commits:
5c8c4a2b by Arnout Engelen at 2018-12-23T12:41:09Z
First stab at documenting the JVM buildinfo format

- - - - -


1 changed file:

- _docs/recording.md


Changes:

=====================================
_docs/recording.md
=====================================
@@ -54,3 +54,44 @@ Tails does not record a buildinfo file per se, but instead the
 [vagrant directory of the main git repo](
 https://gitlab.com/Tails/tails/tree/master/vagrant) contains all information
 necessary to reproducibly rebuild that revision of Tails.
+
+### JVM
+
+The buildinfo conventions for the JVM ecosystem are under active development.
+Join the discussion on the
+[mailinglist]({{ "/docs/contribute/" | prepend: site.baseurl }}).
+
+The format for buildinfo files in the JVM ecosystem is a
+[.properties file](https://en.wikipedia.org/wiki/.properties).
+For multi-module builds, each produced artifact will have its
+own buildinfo file.
+
+Common keys are:
+
+|key|meaning|
+|-|-|
+|name|Name of the packaged entity|
+|group-id|Corresponds to the Maven group id or Ivy organization|
+|artifact-id|Corresponds the the Maven artifact id or Ivy artifact name
+|version|Version of the software|
+|java.version|Version of Java used to build the software|
+|build-tool|Name of the build tool used to build the software, e.g. `maven` or `sbt`|
+
+Each build tool or plugin is free to add additional values to the buildinfo.
+For example, [sbt-reproducible-builds](https://github.com/raboof/sbt-reproducible-builds) adds:
+
+|key|meaning|
+|-|-|
+|sbt.version|Version of sbt used to build the software|
+|scala.version|Version of Scala used to build the software|
+
+A buildinfo file can contain checksums for multiple files, for example for the
+main jar and the accompanying pom.xml:
+
+|key|meaning|
+|-|-|
+|files.0.filename|Filename of the first file|
+|files.0.length|Length of the first file|
+|files.0.checksums.sha256|SHA-256 Checksum of the first file|
+|files.1.filename|Filename of the second file|
+|files.1.|Etc.|



View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-website/commit/5c8c4a2ba67df7ae2b1b7927bfea4e23e1fd028d

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-website/commit/5c8c4a2ba67df7ae2b1b7927bfea4e23e1fd028d
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20181223/1dc61695/attachment.html>