pdf.js/jsdoc.json

{
  "source": {
    "include": ["src/display/api.js"]
  },
  "opts": {
    "destination": "build/jsdoc/"
  },
  "templates": {
    "default": {
      "includeDate": false
    }
  }
}
Implement reproducibility for the JSDoc builds The JSDoc builds are currently not reproducible because a timestamp is included in the output, meaning that two builds from identical source code, made at different times, result in different output. This is undesirable because it makes diffing the output difficult, for instance recently during the Gulp 5 efforts, because the timestamp differences are irrelevant and could obscure actually important differences in the output during e.g. code changes. Moreover, reprodicibility of build artifacts has become increasingly important; please refer to the Reproducible Builds initiative at https://reproducible-builds.org (note the "Why does it matter?" section specifically) and https://reproducible-builds.org/docs/timestamps which further explains the problem of timestamps in build artifacts. This commit fixes the issue by configuring JSDoc to not include the timestamps in the output. It's not relevant for end users and without it the build is fully reproducible so that identical source code builds result in bit-by-bit identical output artifacts. Note that this option sadly can only be set via a configuration file, and not via the command line parameters like we used to have, so for consistency we also move the other options into the configuration file so they are all in one place and the Gulpfile becomes a bit simpler. 2024-06-16 14:47:06 +02:00			`{`
			`"source": {`
			`"include": ["src/display/api.js"]`
			`},`
			`"opts": {`
			`"destination": "build/jsdoc/"`
			`},`
			`"templates": {`
			`"default": {`
			`"includeDate": false`
			`}`
			`}`
			`}`