ci(release-please): Release please single PR (#1176)

JIRA: CPOUI5FOUNDATION-1142
JIRA: CPOUI5FOUNDATION-1164

This change modifies several things, so the whole workflow can be
complete:
- Creates a Release Please process
    - Adds release please configuration and pipeline
    - Releases the all of the package at once with a single PR
- Generates an `npm-shrinkwrap.json` for the CLI package before being
released (out of monorepo's root `package-lock.json`)
- Introduce a new package `shrinkwrap-extractor` to deal with
`@ui5/cli`'s `npm-shrinkwrap.json` generation in a monorepository
environment
- Clear separation between "public" and "internal" packages
- Adjusts pipelines to deal with the new structure:
    - github-ci.yml
    - reuse-compliance.yml
- Adjust `deploy-vitepress-docs.yaml` so that it will generate API
documentation out of published NPM packages and not from the packages
within the monorepo
- Align `package.json` scripts, so that they can be easily (re)used
within the monorepo structure.

Author: d3xter666

.github/workflows/deploy-vitepress-docs.yaml

@@ -40,18 +40,23 @@ jobs:
                 cache: npm
             - name: Setup Pages
               uses: actions/configure-pages@v4
-            - name: Install dependencies
-              run: npm ci --engine-strict # --engine-strict is used to fail-fast if deps require node versions unsupported by the repo
-            - name: Install documentation dependencies
-              working-directory: packages/documentation
-              run: npm ci --engine-strict # --engine-strict is used to fail-fast if deps require node versions unsupported by the repo
+            - name: Copy documentation package to isolated directory
+              run: |
+                  # Create isolated directory for documentation
+                  # So, that API.json will be build from the NPM packages,
+                  # and not from workspace packages
+                  mkdir -p ${{ runner.temp }}/isolated-docs
+                  cp -r internal/documentation/. ${{ runner.temp }}/isolated-docs/
+            - name: Install documentation dependencies from NPM
+              working-directory: ${{ runner.temp }}/isolated-docs
+              run: npm ci --engine-strict
             - name: Fetch gh-pages branch
               run: git fetch origin gh-pages --depth=1
             - name: generate CLI doc
-              working-directory: packages/documentation
+              working-directory: ${{ runner.temp }}/isolated-docs
               run: npm run generate-cli-doc
             - name: Build vitepress build
-              working-directory: packages/documentation
+              working-directory: ${{ runner.temp }}/isolated-docs
               run: |
                 # The base output
                 npm run build:vitepress -- --base="/${{ github.event.repository.name }}/${DOC_VERSION}/"
@@ -60,11 +65,10 @@ jobs:
                 npm run build:vitepress -- --base="/${{ github.event.repository.name }}/${DOC_ALIAS}/" --outDir="dist-${DOC_ALIAS}"
                 npm run build:assets -- ./dist-${DOC_ALIAS}
             - name: Build jsdoc
-              working-directory: packages/documentation
+              working-directory: ${{ runner.temp }}/isolated-docs
               run: npm run jsdoc-generate
             # TODO: Skip for now deployment of the schema until we do a Schema Version 5 release
-            # - name: Build Schema
-            #   run: |
+            # - name: Build Sch3 |
             #       npm run schema-generate
             #       npm run schema-workspace-generate
             - name: Checkout gh-pages
@@ -81,16 +85,16 @@ jobs:
                   rm -rf ./gh-pages/${DOC_ALIAS}
 
                   # Main version route
-                  cp -R ./packages/documentation/dist ./gh-pages/${DOC_VERSION}/
+                  cp -R ${{ runner.temp }}/isolated-docs/dist ./gh-pages/${DOC_VERSION}/
 
                   # Alias route. E.g., next, latest, stable, etc.
                   # For vitepress must be a copy with different config, not a symlink
-                  cp -R ./packages/documentation/dist-${DOC_ALIAS} ./gh-pages/${DOC_ALIAS}/
+                  cp -R ${{ runner.temp }}/isolated-docs/dist-${DOC_ALIAS} ./gh-pages/${DOC_ALIAS}/
                   # Symlink the api docs to avoid duplication
                   ln -s ../${DOC_VERSION}/api ./gh-pages/${DOC_ALIAS}/api
 
                   # TODO: Enable when v5 release is done
-                  # cp ./packages/documentation/scripts/resources/custom404.html ./gh-pages/404.html
+                  # cp ${{ runner.temp }}/isolated-docs/scripts/resources/custom404.html ./gh-pages/404.html
             - name: Publish Docs
               run: |
                   cd ./gh-pages

.github/workflows/github-ci.yml

@@ -40,14 +40,16 @@ jobs:
       run: npm run unit
 
     - name: Generate JSDoc documentation
-      working-directory: packages/documentation
-      run: |
-        npm ci --engine-strict # --engine-strict is used to fail-fast if deps require node versions unsupported by the repo
-        npm run jsdoc-generate
+      working-directory: internal/documentation
+      run: npm run jsdoc-generate
 
     - name: Generate merged JSON schema
       run: npm run schema-generate
 
     - name: Generate CLI documentation
-      working-directory: packages/documentation
+      working-directory: internal/documentation
       run: npm run generate-cli-doc
+
+    - name: Check shrinkwrap integrity
+      working-directory: internal/shrinkwrap-extractor
+      run: npm run test

.github/workflows/release-please.yml

@@ -0,0 +1,85 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write # Required for trusted publishing via OIDC (https://docs.npmjs.com/trusted-publishers)
+
+jobs:
+  release-please:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Node.js LTS
+        uses: actions/setup-node@v5
+        with:
+         node-version: 24.x
+
+      - name: Run Release Please to update PRs and create releases
+        uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: "${{ secrets.GITHUB_TOKEN }}"
+
+  publish-packages:
+    runs-on: ubuntu-24.04
+    needs: release-please
+    if: needs.release-please.outputs.releases_created == 'true'
+    strategy:
+      # Sequential publishing ensures dependencies exist on NPM before dependents are published
+      # Order: logger → fs → builder → server → project (CLI handled separately for shrinkwrap generation)
+      max-parallel: 1
+      matrix:
+        package: [logger, fs, builder, server, project]
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Node.js LTS
+        uses: actions/setup-node@v5
+        with:
+          node-version: 24.x
+          
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish ${{ matrix.package }} package
+        working-directory: packages/${{ matrix.package }}
+        run: |
+          echo "🚀 Publishing @ui5/${{ matrix.package }}"
+          
+          # TODO: Uncomment when ready to publish
+          # npm publish --access public
+
+  publish-cli:
+    runs-on: ubuntu-24.04
+    needs: [release-please, publish-packages]
+    if: needs.release-please.outputs.releases_created == 'true'
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Node.js LTS
+        uses: actions/setup-node@v5
+        with:
+          node-version: 24.x
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate npm-shrinkwrap.json
+        working-directory: packages/cli
+        run: |
+          set -e
+          node ../../internal/shrinkwrap-extractor/cli.js ../../
+
+      - name: Publish @ui5/cli package
+        working-directory: packages/cli
+        run: |
+          echo "🚀 Publishing @ui5/cli"
+          # TODO: Uncomment when ready to publish
+          # npm publish --access public

.github/workflows/reuse-compliance.yml

@@ -18,9 +18,10 @@ jobs:
     strategy:
       matrix:
         package:
+          - "internal/documentation"
+          - "internal/shrinkwrap-extractor"
           - "packages/builder"
           - "packages/cli"
-          - "packages/documentation"
           - "packages/fs"
           - "packages/logger"
           - "packages/project"

.gitignore

@@ -63,7 +63,7 @@ site/
 !packages/**/test/fixtures/**/node_modules
 
 # Documentation
-packages/documentation/docs/pages/CLI.md
-packages/documentation/.vitepress/dist
-packages/documentation/.vitepress/cache
-packages/documentation/dist
+internal/documentation/docs/pages/CLI.md
+internal/documentation/.vitepress/dist
+internal/documentation/.vitepress/cache
+internal/documentation/dist

.release-please-manifest.json

@@ -0,0 +1,8 @@
+{
+	"packages/logger": "4.0.2",
+	"packages/fs": "4.0.2",
+	"packages/builder": "4.0.11",
+	"packages/server": "4.0.7",
+	"packages/project": "4.0.6",
+	"packages/cli": "4.0.26"
+}

README.md

@@ -6,7 +6,8 @@ export default [
 		// to add to common config
 		ignores: [
 			"**/site/",
-			"packages/"
+			"packages/",
+			"internal/"
 		]
 	},
 	...eslintCommonConfig, // Load common ESLint config