GLSP-1578: Update Github actions flows (#36)

tortmayr · web-flow · commit 6fca911b7996 · 2025-09-19T09:40:33.000+02:00
- Update github action workflows
- Switch to 2.6.0-next version
- Clean up root scripts
- Add eslint/prettier ignore files
- Fix minor formatting issues
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,12 @@
+# Compiled output
+**/dist/
+**/lib/
+**/node_modules/
+**/repositories/
+
+# Build files
+**/.eslintrc.js
+**/esbuild.js
+
+# Other generated files
+**/*.map
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -2,7 +2,6 @@
 module.exports = {
     root: true,
     extends: ['@eclipse-glsp'],
-    ignorePatterns: ['**/{node_modules,lib}', '**/.eslintrc.js'],
     parserOptions: {
         tsconfigRootDir: __dirname,
         project: 'tsconfig.eslint.json'
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -25,5 +25,5 @@ to learn how to report vulnerabilities.
 
 <!-- Please check, when if it applies to your change. -->
 
-- [ ] This PR should be mentioned in the changelog
-- [ ] This PR introduces a breaking change (if yes, provide more details below for the changelog and the migration guide)
+-   [ ] This PR should be mentioned in the changelog
+-   [ ] This PR introduces a breaking change (if yes, provide more details below for the changelog and the migration guide)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,8 +15,8 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 60
     steps:
-      - uses: actions/checkout@v4.1.7
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: 20.x
       - name: Install dependencies
@@ -32,8 +32,8 @@ jobs:
     timeout-minutes: 60
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4.1.7
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: 20.x
       - name: Install
@@ -62,8 +62,8 @@ jobs:
       GLSP_SERVER_PLAYWRIGHT_MANAGED: 'true'
       GLSP_WEBSOCKET_PATH: 'workflow'
     steps:
-      - uses: actions/checkout@v4.1.7
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: '20'
       - name: Install dependencies
@@ -82,7 +82,7 @@ jobs:
         run: xvfb-run -a yarn test
       - name: Upload Playwright report
         if: ${{ always() }}
-        uses: actions/upload-artifact@v4.3.4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: playwright-report-node
           path: examples/workflow-test/playwright-report/
@@ -100,12 +100,12 @@ jobs:
       GLSP_SERVER_PLAYWRIGHT_MANAGED: 'true'
       GLSP_WEBSOCKET_PATH: 'workflow'
     steps:
-      - uses: actions/checkout@v4.1.7
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: '20'
       - name: Set up JDK
-        uses: actions/setup-java@v4.2.1
+        uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1
         with:
           distribution: 'temurin'
           java-version: '17'
@@ -125,7 +125,7 @@ jobs:
         run: xvfb-run -a yarn test
       - name: Upload Playwright report
         if: ${{ always() }}
-        uses: actions/upload-artifact@v4.3.4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: playwright-report-java
           path: examples/workflow-test/playwright-report/
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -12,12 +12,9 @@
 name: 'CodeQL'
 
 on:
-  push:
-    branches: ['main']
-  pull_request:
-    branches: ['main']
+  workflow_dispatch:
   schedule:
-    - cron: '20 18 * * 0'
+    - cron: '20 18 * * 0' # At 18:20 on Sunday
 
 jobs:
   analyze:
@@ -56,11 +53,11 @@ jobs:
         # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@16df4fbc19aea13d921737861d6c622bf3cefe23 # v2.23.0
         with:
           languages: ${{ matrix.language }}
           build-mode: ${{ matrix.build-mode }}
@@ -88,6 +85,6 @@ jobs:
           exit 1
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@16df4fbc19aea13d921737861d6c622bf3cefe23 # v2.23.0
         with:
           category: '/language:${{matrix.language}}'
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -7,7 +7,7 @@ concurrency:
 on:
   workflow_dispatch:
   schedule:
-    - cron: '20 18 * * 1'
+    - cron: '20 18 * * 1' # At 18:20 on Monday
 
 jobs:
   playwright-node:
@@ -27,8 +27,8 @@ jobs:
       GLSP_SERVER_PLAYWRIGHT_MANAGED: 'true'
       GLSP_WEBSOCKET_PATH: 'workflow'
     steps:
-      - uses: actions/checkout@v4.1.7
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: '20'
       - name: Install dependencies
@@ -52,7 +52,7 @@ jobs:
           fi
       - name: Upload Playwright report
         if: ${{ always() }}
-        uses: actions/upload-artifact@v4.3.4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: playwright-report-${{ matrix.os }}
           path: examples/workflow-test/playwright-report/
diff --git a/.github/workflows/prepare-release.yml b/.github/workflows/prepare-release.yml
@@ -0,0 +1,38 @@
+name: Prepare Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: 'Release type (major, minor, patch, next, or custom)'
+        required: true
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+          - next
+          - custom
+      custom_version:
+        description: 'Custom version (required if release_type is custom)'
+        required: false
+        type: string
+      branch:
+        description: 'Branch to use for the release repo (default: default branch)'
+        required: false
+        type: string
+      draft:
+        description: 'Create PR as draft'
+        required: false
+        type: boolean
+        default: false
+
+jobs:
+  prepare-release:
+    uses: eclipse-glsp/glsp/.github/workflows/prepare-release.yml@master
+    with:
+      release_type: ${{ inputs.release_type }}
+      custom_version: ${{ inputs.custom_version }}
+      release_repo: glsp-playwright
+      branch: ${{ inputs.branch }}
+      draft: ${{ inputs.draft }}
diff --git a/.github/workflows/publish-next.yml b/.github/workflows/publish-next.yml
@@ -18,7 +18,7 @@ jobs:
     env:
       changes: true
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           # To fetch all history for all branches and tags.
           # Required for lerna to determine the version of the next package.
@@ -33,7 +33,7 @@ jobs:
             echo "changes=false" >> $GITHUB_ENV
           fi
         if: github.event_name == 'workflow_run'
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: 20.x
           registry-url: 'https://registry.npmjs.org'
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,19 @@
+# Dependencies
+node_modules/
+
+**/repositories/
+
+# Build outputs
+lib/
+dist/
+
+# Generated files
+*.min.js
+*.min.css
+
+# Lock files
+package-lock.json
+yarn.lock
+
+# Logs
+*.log
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -17,9 +17,7 @@
   "task.autoDetect": "off",
   "typescript.tsdk": "node_modules/typescript/lib",
   "typescript.preferences.importModuleSpecifier": "relative",
-  "typescript.preferences.autoImportFileExcludePatterns": [
-    "packages/*/src/index.ts"
-  ],
+  "typescript.preferences.autoImportFileExcludePatterns": ["packages/*/src/index.ts"],
   "[css]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -5,6 +5,7 @@ Version 1.2
 August 19, 2020
 
 ## Our Pledge
+
 <img align="right" src="https://www.eclipse.org/org/images/eclipse_code_of_conduct.png" width="246" style="padding: 0px 5px 0px 5px;">
 In the interest of fostering an open and welcoming environment, we as community members, contributors, committers, and project leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Eclipse GLSP - Playwright [![CI](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/ci.yml/badge.svg)](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/ci.yml) [![Publish next](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/publish-next.yml/badge.svg)](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/publish-next.yml)
+# Eclipse GLSP - Playwright [![CI](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/ci.yml/badge.svg)](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/ci.yml?branch=main) [![Publish next](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/publish-next.yml/badge.svg)](https://github.com/eclipse-glsp/glsp-playwright/actions/workflows/publish-next.yml)
 
 A Playwright-based framework for testing the [Graphical Language Server Platform (GLSP)](https://github.com/eclipse-glsp/glsp).
 
diff --git a/examples/workflow-test/package.json b/examples/workflow-test/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-glsp/workflow-test",
-  "version": "2.5.0",
+  "version": "2.6.0-next",
   "private": true,
   "description": "Example project for glsp-playwright",
   "homepage": "https://www.eclipse.org/glsp/",
@@ -46,11 +46,11 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@eclipse-glsp/client": "2.5.0"
+    "@eclipse-glsp/client": "next"
   },
   "devDependencies": {
-    "@eclipse-glsp-examples/workflow-server-bundled": "2.5.0",
-    "@eclipse-glsp/glsp-playwright": "2.5.0",
+    "@eclipse-glsp-examples/workflow-server-bundled": "next",
+    "@eclipse-glsp/glsp-playwright": "2.6.0-next",
     "@playwright/test": "^1.47.0",
     "@theia/playwright": "~1.64.0",
     "@types/yargs": "^17.0.32",
diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "2.5.0",
+  "version": "2.6.0-next",
   "npmClient": "yarn",
   "command": {
     "run": {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "parent",
-  "version": "2.5.0",
+  "version": "2.6.0-next",
   "private": true,
   "workspaces": {
     "packages": [
@@ -15,19 +15,19 @@
     "all": "yarn clean && yarn install && yarn lint",
     "build": "yarn compile && yarn compile:alias",
     "check:headers": "glsp checkHeaders . -t lastCommit",
-    "check:pr": "yarn all && yarn check:headers",
+    "check:pr": "yarn all && yarn format:checkyarn && check:headers",
     "clean": "lerna run clean",
     "compile": "tsc -b",
     "compile:alias": "lerna run compile:alias",
     "example": "yarn -s --cwd ./examples/workflow-test",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "generate:index": "lerna run generate:index  && yarn lint:fix",
-    "lint": "eslint --ext .ts,.tsx  --ignore-pattern '**/repositories/**' .",
+    "lint": "eslint --ext .ts,.tsx .",
     "lint:ci": "yarn lint --output-file eslint_report.json --format json",
     "lint:fix": " yarn lint --fix",
     "prepare": "lerna run prepare && yarn build",
-    "publish:latest": "lerna publish from-git --no-push",
     "publish:next": "lerna publish preminor --exact --canary --preid next --dist-tag next --no-git-tag-version --no-push --ignore-scripts --yes",
-    "publish:prepare": "lerna version --ignore-scripts --yes --no-push --exact",
     "repo": "yarn -s example repo",
     "test": "cd examples/workflow-test && yarn test",
     "test:standalone": "yarn example test:standalone",
@@ -38,12 +38,13 @@
     "watch": "concurrently --kill-others -n tsc,alias -c red,yellow \"tsc -b -w --preserveWatchOutput\" \"yarn --cwd packages/glsp-playwright watch:alias\""
   },
   "devDependencies": {
-    "@eclipse-glsp/dev": "2.5.0",
+    "@eclipse-glsp/dev": "next",
     "@estruyf/github-actions-reporter": "^1.7.0",
     "@types/node": "20.x",
     "concurrently": "^8.2.2",
     "eslint-import-resolver-typescript": "^3.5.3",
     "lerna": "^7.4.1",
+    "mocha-ctrf-json-reporter": "0.0.9",
     "tsc-alias": "1.8.10",
     "typescript": "^5.9.2"
   },
diff --git a/packages/glsp-playwright/package.json b/packages/glsp-playwright/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-glsp/glsp-playwright",
-  "version": "2.5.0",
+  "version": "2.6.0-next",
   "description": "Playwright-based testing framework for GLSP",
   "homepage": "https://www.eclipse.org/glsp/",
   "bugs": "https://github.com/eclipse-glsp/glsp/issues",
diff --git a/packages/glsp-playwright/src/glsp/features/tool-palette/tool-palette-item.base.ts b/packages/glsp-playwright/src/glsp/features/tool-palette/tool-palette-item.base.ts
@@ -18,7 +18,10 @@ import type { GLSPLocator } from '~/remote/locator';
 import type { GLSPToolPalette } from './tool-palette.po';
 
 export abstract class BaseToolPaletteItem extends Locateable {
-    constructor(locator: GLSPLocator, public readonly toolPalette: GLSPToolPalette) {
+    constructor(
+        locator: GLSPLocator,
+        public readonly toolPalette: GLSPToolPalette
+    ) {
         super(locator);
     }
 }
diff --git a/packages/glsp-playwright/src/integration/vscode/po/workbench-activitybar.po.ts b/packages/glsp-playwright/src/integration/vscode/po/workbench-activitybar.po.ts
@@ -25,7 +25,10 @@ export class VSCodeWorkbenchActivitybar {
     readonly extensionsItemLocator;
     readonly explorerItemLocator;
 
-    constructor(protected readonly page: Page, protected readonly selector = '[id="workbench.parts.activitybar"]') {
+    constructor(
+        protected readonly page: Page,
+        protected readonly selector = '[id="workbench.parts.activitybar"]'
+    ) {
         this.locator = this.page.locator(this.selector);
         this.explorerItemLocator = this.locator.locator('.codicon-explorer-view-icon');
         this.extensionsItemLocator = this.locator.locator('.codicon-extensions-view-icon');
diff --git a/packages/glsp-playwright/src/integration/vscode/po/workbench-view-extensions.po.ts b/packages/glsp-playwright/src/integration/vscode/po/workbench-view-extensions.po.ts
@@ -22,7 +22,10 @@ import type { Locator, Page } from '@playwright/test';
 export class VSCodeWorkbenchViewExtensions {
     readonly locator;
 
-    constructor(protected readonly page: Page, protected readonly selector = '[id="workbench.view.extensions"]') {
+    constructor(
+        protected readonly page: Page,
+        protected readonly selector = '[id="workbench.view.extensions"]'
+    ) {
         this.locator = this.page.locator(this.selector);
     }
 
diff --git a/tsconfig.eslint.json b/tsconfig.eslint.json
@@ -3,7 +3,6 @@
   "compilerOptions": {
     "noEmit": true
   },
-  "exclude": ["**/node_modules", "**/.eslintrc.js"],
   "include": [
     "packages/*/src",
     "examples/*/src",
diff --git a/yarn.lock b/yarn.lock
