Skip to content

Commit

Permalink
doc: fix minor documentation issues [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
v1nc3n4 committed Jul 8, 2023
1 parent 9ff7fe3 commit a910fce
Show file tree
Hide file tree
Showing 10 changed files with 42 additions and 20 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/plugin/buildSrc/out/
/plugin/out/
/site/.frontend-gradle-plugin
/site/.nuxt/
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,15 @@ gradlew pluginUnderTestMetadata
## Continuous integration

The project relies on [GitHub Actions][github-actions] to integrate continuously every changes (pull requests) in the
repository. The configuration actually allows to build and test the plugin with Adoptium Temurin JDK 11 64 bits, on the
repository. The configuration actually allows to build and test the plugin with Adoptium Temurin JDK 17 64 bits, on the
environments below:

- Linux Ubuntu 22.04.2
- Mac OS 12.6.5
- Windows Server 2022

Ubuntu is the reference O/S, used to analyze the source code with SonarCloud. Developments are frequently done on a
Windows 10 Professionnal workstation with Adoptium Temurin JDK 11 64 bits and [IntelliJ IDEA][intellij-idea].
Windows 10 Professionnal workstation with Adoptium Temurin JDK 17 64 bits and [IntelliJ IDEA][intellij-idea].

[apache-commons-compress]: <https://commons.apache.org/proper/commons-compress/> (Apache Commons Compress)
[apache-http-components]: <https://hc.apache.org/> (Apache HttpComponents)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<a href="https://github.com/siouan/frontend-gradle-plugin/releases/tag/v7.0.0"><img src="https://img.shields.io/badge/Latest%20release-7.0.0-blue.svg" alt="Latest release 7.0.0"/></a>
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg" alt="License Apache 2.0"/></a>
<br/>
<a href="https://github.com/siouan/frontend-gradle-plugin/actions/workflows/build.yml"><img src="https://github.com/siouan/frontend-gradle-plugin/actions/workflows/build.yml/badge.svg?branch=7.0-jdk11" alt="Build status"/></a>
<a href="https://github.com/siouan/frontend-gradle-plugin/actions/workflows/build.yml"><img src="https://github.com/siouan/frontend-gradle-plugin/actions/workflows/build.yml/badge.svg?branch=7.0-jdk17" alt="Build status"/></a>
<a href="https://sonarcloud.io/project/overview?id=siouan_frontend-gradle-plugin"><img src="https://sonarcloud.io/api/project_badges/measure?project=siouan_frontend-gradle-plugin&metric=alert_status" alt="Quality gate status"/></a>
<a href="https://sonarcloud.io/summary/overall?id=siouan_frontend-gradle-plugin"><img src="https://sonarcloud.io/api/project_badges/measure?project=siouan_frontend-gradle-plugin&metric=coverage" alt="Code coverage"/></a>
<a href="https://sonarcloud.io/summary/overall?id=siouan_frontend-gradle-plugin"><img src="https://sonarcloud.io/api/project_badges/measure?project=siouan_frontend-gradle-plugin&metric=reliability_rating" alt="Reliability"/></a>
Expand Down
Binary file modified gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
1 change: 1 addition & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-all.zip
networkTimeout=10000
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
19 changes: 12 additions & 7 deletions gradlew
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
Expand All @@ -80,13 +80,10 @@ do
esac
done

APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

APP_NAME="Gradle"
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
Expand Down Expand Up @@ -143,12 +140,16 @@ fi
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
Expand Down Expand Up @@ -193,6 +194,10 @@ if "$cygwin" || "$msys" ; then
done
fi


# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
Expand Down
1 change: 1 addition & 0 deletions gradlew.bat
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal

set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<fgp-code>file("${projectDir}/node")</fgp-code>). When property
<fgp-property-link name="nodeDistributionProvided" /> is <fgp-code>true</fgp-code>, this property may be
used to point the directory where the distribution is already installed. If <fgp-code>null</fgp-code>, the
plugin will try to find the installation directory with the <fgp-code>FGP_NODEJS_HOME</fgp-code> environment
plugin tries to find the installation directory with the <fgp-code>FGP_NODEJS_HOME</fgp-code> environment
variable.
</p>
</fgp-property>
Expand Down
16 changes: 9 additions & 7 deletions site/src/components/task/install-frontend-task.vue
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@
<fgp-task-link name="installNode" /> task). Resolving these inputs/outputs is a bit complex,
since it depends on the package manager used, the value of the
<fgp-property-link name="installScript" /> property, and the files present in the project.
That's why incremental build for this task is not supported by now. Hereafter are some
guidelines to help adding custom inputs and outputs under certain circumstances:
That's why incremental build for this task is not available out-of-the-box by now. However,
some <fgp-repo-link path="/tree/master/examples">examples</fgp-repo-link> provide guidelines
to customize this task and limit executions under certain circumstances. Notes hereafter provide
also some unofficial ideas:
</p>
<ul>
<li><fgp-npm-link />: inputs may be one or
Expand All @@ -43,9 +45,8 @@
<fgp-code>node_modules</fgp-code> directory and the
<fgp-code>package-lock.json</fgp-code> file (see
<fgp-npm-docs-link path="/cli/v9/commands/npm-install">npm install</fgp-npm-docs-link>).
The set of input files also depends on the command run. For example, if the
<fgp-property-link name="installScript" /> property is set with
<fgp-code>run ci</fgp-code>, files <fgp-code>npm-shrinkwrap.json</fgp-code> and
If the <fgp-property-link name="installScript" /> property is set with
<fgp-code>ci</fgp-code>, files <fgp-code>npm-shrinkwrap.json</fgp-code> and
<fgp-code>package-lock.json</fgp-code> may be the only possible input file, if one or
the other exists, and the <fgp-code>node_modules</fgp-code> directory the only output.
</li>
Expand All @@ -57,8 +58,9 @@
<li><fgp-yarn-link />: inputs may be one or
more of files <fgp-code>package.json</fgp-code>, <fgp-code>yarn.lock</fgp-code>,
while outputs may be the
<fgp-code>node_modules</fgp-code> directory or the <fgp-code>.pnp.cjs</fgp-code> file
(<fgp-yarn-link label="Zero-installs" title="Zero-Install feature" />) and the
<fgp-code>node_modules</fgp-code> directory, or the <fgp-code>.pnp.cjs</fgp-code> file
and the <fgp-code>.yarn/cache</fgp-code> directory
(<fgp-yarn-link label="Zero-installs" title="Zero-Install feature" />), and the
<fgp-code>yarn.lock</fgp-code> file.
</li>
</ul>
Expand Down
16 changes: 14 additions & 2 deletions site/src/pages/getting-started.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
The following tools must be installed to use the plugin:
</p>
<ul>
<li><fgp-gradle-link /> 6.1+</li>
<li>JDK 11+ 64 bits</li>
<li>JDK 17 build: <fgp-gradle-link /> 7.3+</li>
<li>JDK 11 build: <fgp-gradle-link /> 6.1+</li>
</ul>
<p>
The plugin is built and tested on Linux, Mac OS, Windows (see the list of build environments used in
Expand Down Expand Up @@ -38,12 +38,16 @@
<fgp-gradle-scripts id="install-gradle-dsl">
<template #groovy>
<pre><fgp-code>plugins {
<fgp-code-comment>// For JDK 17+</fgp-code-comment>
id 'org.siouan.frontend-jdk17' version '7.0.0'
<fgp-code-comment>// For JDK 11+</fgp-code-comment>
id 'org.siouan.frontend-jdk11' version '7.0.0'
}</fgp-code></pre>
</template>
<template #kotlin>
<pre><fgp-code>plugins {
<fgp-code-comment>// For JDK 17+</fgp-code-comment>
id("org.siouan.frontend-jdk17") version "7.0.0"
<fgp-code-comment>// For JDK 11+</fgp-code-comment>
id("org.siouan.frontend-jdk11") version "7.0.0"
}</fgp-code></pre>
Expand All @@ -63,11 +67,15 @@
url 'https://plugins.gradle.org/m2/'
}
dependencies {
<fgp-code-comment>// For JDK 17+</fgp-code-comment>
classpath 'org.siouan:frontend-gradle-plugin-jdk17:7.0.0'
<fgp-code-comment>// For JDK 11+</fgp-code-comment>
classpath 'org.siouan:frontend-gradle-plugin-jdk11:7.0.0'
}
}

<fgp-code-comment>// For JDK 17+</fgp-code-comment>
apply plugin: 'org.siouan.frontend-jdk17'
<fgp-code-comment>// For JDK 11+</fgp-code-comment>
apply plugin: 'org.siouan.frontend-jdk11'</fgp-code></pre>
</template>
Expand All @@ -77,11 +85,15 @@ apply plugin: 'org.siouan.frontend-jdk11'</fgp-code></pre>
url = uri("https://plugins.gradle.org/m2/")
}
dependencies {
<fgp-code-comment>// For JDK 17+</fgp-code-comment>
classpath("org.siouan:frontend-gradle-plugin-jdk17:7.0.0")
<fgp-code-comment>// For JDK 11+</fgp-code-comment>
classpath("org.siouan:frontend-gradle-plugin-jdk11:7.0.0")
}
}

<fgp-code-comment>// For JDK 17+</fgp-code-comment>
apply(plugin = "org.siouan.frontend-jdk17")
<fgp-code-comment>// For JDK 11+</fgp-code-comment>
apply(plugin = "org.siouan.frontend-jdk11")</fgp-code></pre>
</template>
Expand Down

0 comments on commit a910fce

Please sign in to comment.