Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[JENKINS-73744] Tweaks to Node.js contributing instructions + renovate fix #9757

Merged
merged 9 commits into from
Sep 21, 2024
Merged

[JENKINS-73744] Tweaks to Node.js contributing instructions + renovate fix #9757

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1aed85f
[JENKINS-73744_follow_up] add npm lock to ignore
scherler Sep 19, 2024
c17ea84
Update CONTRIBUTING.md
scherler Sep 19, 2024
09b3b50
Update CONTRIBUTING.md
scherler Sep 19, 2024
9cf36dd
[JENKINS-73744_follow_up] more word smithing
scherler Sep 20, 2024
18bfd7d
Merge branch 'master' into JENKINS-73744_follow_up
scherler Sep 20, 2024
5287bd5
Update .gitignore
scherler Sep 20, 2024
c62113c
Update CONTRIBUTING.md
scherler Sep 20, 2024
0adfa88
Update CONTRIBUTING.md
scherler Sep 20, 2024
c91edb9
Update CONTRIBUTING.md
basil Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/renovate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
{
"customType": "regex",
"fileMatch": [
"war/pom.xml"
"pom.xml"
],
"matchStrings": [
"<node.version>(?<currentValue>.*?)</node.version>"
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,6 @@ node_modules/

# Generated JavaScript Bundles
jsbundles

# jenkins generated npm lock files at build time, however that should not be checked in ever
package-lock.json
scherler marked this conversation as resolved.
Show resolved Hide resolved
timja marked this conversation as resolved.
Show resolved Hide resolved
scherler marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ MAVEN_OPTS='--add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/ja

### Running the Yarn frontend build

> [!TIP]
> If you already have Node.js installed, you do not need to change your path. Start using `yarn` by enabling (https://yarnpkg.com/corepack)[Corepack] `corepack enable`, if it isn't already; this will add the yarn binary to your PATH.
scherler marked this conversation as resolved.
Show resolved Hide resolved

To run the Yarn frontend build, after [building the WAR file](#building-the-war-file), add the downloaded versions of Node and Yarn to your path:

```sh
Expand All @@ -74,7 +77,7 @@ On one terminal, start a development server that will not process frontend asset
MAVEN_OPTS='--add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.io=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED' mvn -pl war jetty:run -Dskip.yarn
```

Open another terminal and start a [webpack](https://webpack.js.org/) dev server, after [adding Node and Yarn to your path](#running-the-yarn-frontend-build):
Open another terminal and start a [webpack](https://webpack.js.org/) dev server, after [optionally adding Node and Yarn to your path](#running-the-yarn-frontend-build):

```sh
yarn start
Expand Down Expand Up @@ -108,13 +111,13 @@ To automatically fix backend issues, run:
mvn spotless:apply
```

To view frontend issues, after [adding Node and Yarn to your path](#running-the-yarn-frontend-build), run:
To view frontend issues, after [optionally adding Node and Yarn to your path](#running-the-yarn-frontend-build), run:

```sh
yarn lint
```

To fix frontend issues, after [adding Node and Yarn to your path](#running-the-yarn-frontend-build), run:
To fix frontend issues, after [optionally adding Node and Yarn to your path](#running-the-yarn-frontend-build), run:

```sh
yarn lint:fix
Expand Down