Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Move all JavaScript projects into single PNPM workspace #24537

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

Merged
jonkoops merged 1 commit into from
Apr 2, 2024
Merged

Move all JavaScript projects into single PNPM workspace #24537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@
# UI (@keycloak/ui-maintainers)
###################################################################################################

/package.json @keycloak/ui-maintainers
/pnpm-lock.yaml @keycloak/ui-maintainers
/pnpm-workspace.yaml @keycloak/ui-maintainers
/js/ @keycloak/ui-maintainers
/adapters/oidc/js/ @keycloak/ui-maintainers
/rest/admin-ui-ext/ @keycloak/ui-maintainers
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/pnpm-setup/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ inputs:
node-version:
description: Node.js version
required: false
default: "18"
default: "20"

working-directory:
description: The working directory where the `pnpm-lock.yaml` file is located.
Expand Down
14 changes: 1 addition & 13 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ updates:
- area/dependencies
- area/ci
- package-ecosystem: npm
directory: /themes/src/main/resources/theme/keycloak/common/resources
directory: /
schedule:
interval: daily
time: "00:00"
Expand All @@ -22,15 +22,3 @@ updates:
labels:
- area/dependencies
- team/ui
- package-ecosystem: npm
directory: js
open-pull-requests-limit: 999
rebase-strategy: disabled
versioning-strategy: increase
schedule:
interval: daily
time: "00:00"
timezone: Etc/GMT
labels:
- area/dependencies
- team/ui
65 changes: 16 additions & 49 deletions .github/workflows/js-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,10 @@ jobs:
- uses: actions/checkout@v4

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- run: pnpm --filter ${{ env.WORKSPACE }} run lint
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} lint

- run: pnpm --filter ${{ env.WORKSPACE }} run build
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} build

keycloak-js:
name: Keycloak JS
Expand All @@ -93,11 +89,8 @@ jobs:
- uses: actions/checkout@v4

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- run: pnpm --filter ${{ env.WORKSPACE }} run build
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} build

keycloak-masthead:
name: Keycloak Masthead
Expand All @@ -110,14 +103,10 @@ jobs:
- uses: actions/checkout@v4

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- run: pnpm --filter ${{ env.WORKSPACE }} run lint
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} lint

- run: pnpm --filter ${{ env.WORKSPACE }} run build
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} build

ui-shared:
name: UI Shared
Expand All @@ -130,14 +119,10 @@ jobs:
- uses: actions/checkout@v4

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- run: pnpm --filter ${{ env.WORKSPACE }} run lint
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} lint

- run: pnpm --filter ${{ env.WORKSPACE }} run build
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} build

account-ui:
name: Account UI
Expand All @@ -150,14 +135,10 @@ jobs:
- uses: actions/checkout@v4

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- run: pnpm --filter ${{ env.WORKSPACE }} run lint
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} lint

- run: pnpm --filter ${{ env.WORKSPACE }} run build
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} build

admin-ui:
name: Admin UI
Expand All @@ -170,20 +151,14 @@ jobs:
- uses: actions/checkout@v4

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- run: pnpm --filter ${{ env.WORKSPACE }} run lint
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} lint

- run: pnpm --filter ${{ env.WORKSPACE }} run test
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} test

- run: pnpm --filter ${{ env.WORKSPACE }} run build
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} build

- run: pnpm --filter ${{ env.WORKSPACE }} run cy:check-types
working-directory: js
- run: pnpm --filter ${{ env.WORKSPACE }} cy:check-types

account-ui-e2e:
name: Account UI E2E
Expand All @@ -198,8 +173,6 @@ jobs:
- uses: actions/checkout@v4

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- name: Download Keycloak server
uses: actions/download-artifact@v3
Expand All @@ -222,11 +195,9 @@ jobs:

- name: Install Playwright browsers
run: pnpm --filter ${{ env.WORKSPACE }} exec playwright install --with-deps
working-directory: js

- name: Run Playwright tests
run: pnpm --filter ${{ env.WORKSPACE }} run test
working-directory: js
run: pnpm --filter ${{ env.WORKSPACE }} test
env:
KEYCLOAK_SERVER: http://localhost:8080

Expand Down Expand Up @@ -277,12 +248,9 @@ jobs:
firefox-version: latest

- uses: ./.github/actions/pnpm-setup
with:
working-directory: js

- name: Compile Admin Client
run: pnpm --filter @keycloak/keycloak-admin-client run build
working-directory: js
run: pnpm --filter @keycloak/keycloak-admin-client build

- name: Download Keycloak server
uses: actions/download-artifact@v3
Expand All @@ -304,8 +272,7 @@ jobs:
KEYCLOAK_ADMIN_PASSWORD: admin

- name: Start LDAP server
run: pnpm --filter ${{ env.WORKSPACE }} run cy:ldap-server &
working-directory: js
run: pnpm --filter ${{ env.WORKSPACE }} cy:ldap-server &

- name: Run Cypress
uses: cypress-io/github-action@v6
Expand Down
11 changes: 10 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,18 @@ quarkus/data/*.db
# Git ephemeral files
*.versionsBackup

# Node.js for frontend-maven-plugin #
# frontend-maven-plugin
node

# Wireit
.wireit

# Vite
dist

# ESLint
.eslintcache

# NPM
node_modules

Expand Down
25 changes: 0 additions & 25 deletions adapters/oidc/js/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,31 +51,6 @@
<plugin>
<groupId>com.github.eirslett</groupId>
<artifactId>frontend-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>install-node-and-pnpm</goal>
</goals>
</execution>
<execution>
<id>pnpm-install</id>
<goals>
<goal>pnpm</goal>
</goals>
<configuration>
<arguments>${pnpm.args.install}</arguments>
</configuration>
</execution>
<execution>
<id>run-build</id>
<goals>
<goal>pnpm</goal>
</goals>
<configuration>
<arguments>run build</arguments>
</configuration>
</execution>
</executions>
<configuration>
<workingDirectory>${js.projectDir}/libs/keycloak-js</workingDirectory>
</configuration>
Expand Down
37 changes: 0 additions & 37 deletions js/.gitignore
View file
Open in desktop

This file was deleted.

25 changes: 0 additions & 25 deletions js/apps/account-ui/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,31 +69,6 @@
<plugin>
<groupId>com.github.eirslett</groupId>
<artifactId>frontend-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>install-node-and-pnpm</goal>
</goals>
</execution>
<execution>
<id>pnpm-install</id>
<goals>
<goal>pnpm</goal>
</goals>
<configuration>
<arguments>${pnpm.args.install}</arguments>
</configuration>
</execution>
<execution>
<id>run-build</id>
<goals>
<goal>pnpm</goal>
</goals>
<configuration>
<arguments>run build</arguments>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.google.code.maven-replacer-plugin</groupId>
Expand Down
8 changes: 4 additions & 4 deletions js/apps/admin-ui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Now that the Keycloak sever is running it's time to run the development server f
To start the development server run the following command:

```bash
pnpm run dev
pnpm dev
```

Once the process of optimization is done your browser will automatically open your local host on port `8080`. From here you will be redirected to the Keycloak server to authenticate, which you can do with the default credentials (`admin`/`admin`).
Expand All @@ -43,7 +43,7 @@ If you want to build the application using Maven and produce a JAR that can be i
Every time you create a commit it should be automatically linted and formatted for you. It is also possible to trigger the linting manually:

```bash
pnpm run lint
pnpm lint
```

## Integration testing with Cypress
Expand All @@ -59,13 +59,13 @@ Ensure the Keycloak and development server are running as [outlined previously](
You can run the tests using the interactive graphical user interface using the following command:

```bash
pnpm run cy:open
pnpm cy:open
```

Alternatively the tests can also run headless as follows:

```
pnpm run cy:run
pnpm cy:run
```

For more information about the Cypress command-line interface consult [the documentation](https://docs.cypress.io/guides/guides/command-line).
Expand Down
26 changes: 0 additions & 26 deletions js/apps/admin-ui/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@
<targetPath>theme/keycloak.v2/admin/resources</targetPath>
<excludes>
<exclude>index.html</exclude>
<exclude>locales/**</exclude>
</excludes>
</resource>
</resources>
Expand All @@ -70,31 +69,6 @@
<plugin>
<groupId>com.github.eirslett</groupId>
<artifactId>frontend-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>install-node-and-pnpm</goal>
</goals>
</execution>
<execution>
<id>pnpm-install</id>
<goals>
<goal>pnpm</goal>
</goals>
<configuration>
<arguments>${pnpm.args.install}</arguments>
</configuration>
</execution>
<execution>
<id>run-build</id>
<goals>
<goal>pnpm</goal>
</goals>
<configuration>
<arguments>run build</arguments>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.google.code.maven-replacer-plugin</groupId>
Expand Down
2 changes: 2 additions & 0 deletions js/apps/keycloak-server/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Keycloak server
server
Loading