Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
jjohannes committed Sep 13, 2024
1 parent 35660eb commit cfe8f65
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fgradlex-org%2Freproducible-builds%2Fbadge%3Fref%3Dmain&style=flat)](https://actions-badge.atrox.dev/gradlex-org/build-parameters/goto?ref=main)
[![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v?label=Plugin%20Portal&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Forg%2Fgradlex%2Freproducible-builds%2Forg.gradlex.reproducible-builds.gradle.plugin%2Fmaven-metadata.xml)](https://plugins.gradle.org/plugin/org.gradlex.build-parameters)

Reproducibility settings applied to some of Gradle's built-in task, that should really be the default.
Reproducibility settings applied to some of Gradle's built-in tasks, that should really be the default.
Compatible with Java 8 and Gradle 8.3 or later.

# Usage

Apply this plugin all projects in your build, and it will configure archive and compilation tasks for reproducibility.
Apply this plugin to all projects in your build, and it configures archive and compilation tasks for reproducibility.

```kotlin
plugins {
Expand Down
21 changes: 10 additions & 11 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
image:https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fgradlex-org%2Freproducible-builds%2Fbadge%3Fref%3Dmain&style=flat["Build Status", link="https://actions-badge.atrox.dev/gradlex-org/reproducible-builds/goto?ref=main"]
image:https://img.shields.io/maven-metadata/v?label=Plugin%20Portal&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Fde%2Fgradlex-org%2Freproducible-builds%2Forg.gradlex.reproducible-builds.gradle.plugin%2Fmaven-metadata.xml["Gradle Plugin Portal", link="https://plugins.gradle.org/plugin/org.gradlex.reproducible-builds"]

Reproducibility settings applied to some of Gradle's built-in task, that should really be the default.
Reproducibility settings applied to some of Gradle's built-in tasks, that should really be the default.
Compatible with Java 8 and Gradle 8.3 or later.

== Usage

Apply this plugin all projects in your build, and it will configure archive and compilation tasks for reproducibility.
Apply this plugin to all projects in your build, and it configures archive and compilation tasks for reproducibility.

[source.multi-language-sample,kotlin]
----
Expand All @@ -19,7 +19,7 @@ plugins {
[source.multi-language-sample,groovy]
----
plugins {
id('org.gradlex.reproducible-builds')
id 'org.gradlex.reproducible-builds'
}
----

Expand All @@ -35,19 +35,19 @@ This sections explains each of the configurations the plugin applies to your bui

|`preserveFileTimestamps`
|`false`
|If not configured, files inside the archive will have timestamps related to when the files where created.
|If not configured, files inside the archive will have timestamps related to when the files were created.

|`reproducibleFileOrder`
|true
|`true`
|If not configured, the order of entries in the archive depends on the underlying filesystem of the machine that creates the archive.

|`dirPermissions`
|`unix(755)`
|
|`unix("755")`
| If not configured, permissions are influence by the operating system on which the build is running and usually differ between Unix and Windows.

|`filePermissions`
|`unix(644)`
|
|`unix("644")`
| If not configured, permissions are influence by the operating system on which the build is running and usually differ between Unix and Windows.
|===

=== Compilation tasks
Expand All @@ -58,5 +58,4 @@ This sections explains each of the configurations the plugin applies to your bui

|`options.encoding`
|`UTF_8`
|If not configured, the platform encoding will be used.

|If not configured, the platform encoding is used.

0 comments on commit cfe8f65

Please sign in to comment.