Skip to content

Commit

Permalink
feat: propose changes to CONTRIBUTING.adoc and propose to remove .yar…
Browse files Browse the repository at this point in the history
…nrc.yml (#421)

Co-authored-by: Adrien Lecharpentier <[email protected]>
  • Loading branch information
krisstern and alecharp authored Jan 8, 2024
1 parent 0cee910 commit 3c87fba
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ node_modules/
### IDE
*.iml
*.idea

### Other
war/.yarnrc.yml

7 changes: 4 additions & 3 deletions docs/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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]
----
Expand All @@ -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.
Expand Down Expand Up @@ -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]
----
Expand Down
1 change: 0 additions & 1 deletion war/.yarnrc.yml

This file was deleted.

2 changes: 1 addition & 1 deletion war/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<groupId>io.jenkins.pluginhealth.scoring</groupId>
<artifactId>plugin-health-scoring-parent</artifactId>
<version>3.3.1-SNAPSHOT</version>
<relativePath>../</relativePath>
<relativePath>../pom.xml</relativePath>
</parent>

<artifactId>plugin-health-scoring-war</artifactId>
Expand Down

0 comments on commit 3c87fba

Please sign in to comment.