diff --git a/.gitignore b/.gitignore index 7417606fa..5a6c604b4 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,7 @@ node_modules/ ### IDE *.iml *.idea + +### Other +war/.yarnrc.yml + diff --git a/docs/CONTRIBUTING.adoc b/docs/CONTRIBUTING.adoc index 7f6e85115..8148087cc 100644 --- a/docs/CONTRIBUTING.adoc +++ b/docs/CONTRIBUTING.adoc @@ -12,7 +12,7 @@ When building, Yarn will bundle the front-end files only. . Install tools .. Java 17 .. Maven 3.8.6 -.. Node 18.10.0 and Yarn 3.2.4 +.. Node 18.10.0 and Yarn 3.2.4 (these should be done in the "war" directory) .. Optional: have Docker installed in your environment . Open the project in your favorite IDE. @@ -23,7 +23,7 @@ Please see the link:ARCHITECTURE.adoc[architecture] document to better understan == How to build locally the application -Once you have installed the tools listed before, you can generate the application binary by running the command: +Once you have installed the tools listed before, you can generate the application binary by running the command, but bewware of additional requirements in the xref:how-to-run-the-application-locally[next subsection]: [source,bash] ---- @@ -38,6 +38,7 @@ You can speed up the process by running the command: mvn package -Dmaven.test.skip ---- +[#how-to-run-the-application-locally] === How to run the application locally Before starting the application, it is required to create a GitHub App, configure environment variables and have access to a PostgreSQL Database. @@ -102,7 +103,7 @@ yarn dev This will build and update the front-end files when you modify them. -In a second terminal run: +First remember to run `mvn clean install` at root. Then, at the `war directory`, in a second terminal run: [source,bash] ---- diff --git a/war/.yarnrc.yml b/war/.yarnrc.yml deleted file mode 100644 index 61af32d51..000000000 --- a/war/.yarnrc.yml +++ /dev/null @@ -1 +0,0 @@ -yarnPath: .yarn/releases/yarn-3.2.4.cjs diff --git a/war/pom.xml b/war/pom.xml index 993b5ff62..e0cf0f2c6 100644 --- a/war/pom.xml +++ b/war/pom.xml @@ -30,7 +30,7 @@ io.jenkins.pluginhealth.scoring plugin-health-scoring-parent 3.3.1-SNAPSHOT - ../ + ../pom.xml plugin-health-scoring-war