feat: add new build scripts and actions (#61)

Sven65 · sebastianthulin · web-flow · commit e4cd2805d5a6 · 2025-11-17T14:55:27.000+01:00
Co-authored-by: Sebastian Thulin &lt;sebastianthulin@users.noreply.github.com&gt;
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,139 +1,88 @@
-name: Bump version and create release
+name: Bump version, build and create release
 
 on:
   push:
-    branches: [main]
+    branches:
+      - main
 
 jobs:
   release:
     runs-on: ubuntu-latest
-
-    steps:
-
-    - name: Checkout
-      uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-
-    - name: Create Release and bump version files
-      uses: helsingborg-stad/release-wp-plugin-action@1.0.2
-      with:
-        php-version: 8.2
-        node-version: 20.6.0
-  build-assets:
-    needs: ['release']
-    runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       packages: write
+
     steps:
-      - name: Get latest release version
-        id: get-version
-        run: |
-          echo "LATEST_RELEASE=$(curl -s https://api.github.com/repos/${{ github.repository }}/releases/latest | jq -r '.tag_name')" >> $GITHUB_ENV
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Update version in package.json
-        run: |
-          # Read the latest release version from environment variable
-          LATEST_VERSION="${{ env.LATEST_RELEASE }}"
 
-          # Update the "version" field in package.json using jq
-          jq --arg version "$LATEST_VERSION" '.version = $version' package.json > temp.json && mv temp.json package.json
-      - name: Setup node
-        uses: actions/setup-node@v3
+      - name: Bump version files (no release yet)
+        uses: helsingborg-stad/release-wp-plugin-action@main
         with:
+          php-version: 8.2
           node-version: 20.6.0
-      - name: Inject access token in .npmrc
-        run: | 
-          echo "registry=https://npm.pkg.github.com/helsingborg-stad" >> ~/.npmrc
-          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> ~/.npmrc
-      - name: Run CI
-        if: ${{ hashFiles('package.json') != '' && hashFiles('package-lock.json') != '' }}
-        run: npm ci --no-progress --no-audit
-      - name: Run install
-        if: ${{ hashFiles('package.json') != '' && hashFiles('package-lock.json') == '' }}
-        run: npm install --no-progress --no-audit
-      - name: Run build
-        if: ${{ hashFiles('package-lock.json') != '' && hashFiles('gulp.js') == '' }}
-        run: npx --yes browserslist@latest --update-db && npm run build
-      - name: Run gulp
-        if: ${{ hashFiles('package-lock.json') != '' && hashFiles('gulp.js') != '' }}
-        run: gulp
-      - name: Publish npm package to GHCR
-        run: npm publish --registry=https://npm.pkg.github.com
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Create assets zip
-        uses: thedoctor0/zip-release@0.7.5
-        if: ${{ hashFiles('dist/') != '' }}
-        with:
-          type: zip
-          filename: '../assets.zip'
-          directory: dist
-          exclusions: '*.git* /*node_modules/* */source/sass/* */source/js/*'
-      - name: Upload Assets
-        uses: helsingborg-stad/upload-artifact@1.0.0
-        if: ${{ hashFiles('assets.zip') != '' }}
-        with:
-          artifact: "assets.zip"
-          gh_token: ${{ secrets.GITHUB_TOKEN }}
-          release: ${{ env.LATEST_RELEASE }}
-          repo: ${{ github.repository }}
-          artifact_mime_type: application/zip
+          skip-release: true  # custom flag you added
+
+      - name: Pull latest main with bumped version
+        run: |
+          git fetch origin main
+          git checkout main
+          git pull origin main
+
+      - name: Extract version
+        id: version
+        run: |
+          VERSION=$(jq -r '.version' package.json)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Detected version: $VERSION"
 
+      # --- PHP Build ---
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
-        if: ${{ hashFiles('composer.json') != '' }}
         with:
-          tools: composer
-      
-      - name: Build PHP
-        if: ${{ hashFiles('composer.json') != '' }}
+          php-version: "8.2"
+
+      - name: Configure npm for GitHub Packages
         run: |
-          composer install --prefer-dist --no-progress --no-dev
-          composer dump-autoload
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
+          echo "@helsingborg-stad:registry=https://npm.pkg.github.com" >> ~/.npmrc
+
+      - name: Run PHP build script
+        run: php build.php --no-composer --cleanup --release
 
-      - name: Process removables
+      - name: Overwrite .gitignore for release branch
         run: |
-          removables=('.git'
-            '.gitignore'
-            '.github'
-            '.gitattributes'
-            'build.php'
-            '.npmrc'
-            'composer.json'
-            'composer.lock'
-            'env-example'
-            'webpack.config.js'
-            'package-lock.json'
-            'package.json'
-            'phpunit.xml.dist'
-            'README.md'
-            'gulpfile.js'
-            './node_modules/'
-            './source/sass/'
-            './source/js/'
-            'LICENSE'
-            'babel.config.js'
-            'yarn.lock'
-          )
-          for item in ${removables[@]}; do rm -rf $item; done;
+          printf "/*\n!/dist\n!/dist/**\n!/source/php\n!/source/php/**\n" > .gitignore
 
-      - name: Create release zip
-        uses: thedoctor0/zip-release@0.7.5
-        with:
-          type: zip
-          filename: 'release.zip'
-          exclusions: '*.git* /*node_modules/* */source/sass/* */source/js/*'
-      
-      - name: Upload release
-        uses: helsingborg-stad/upload-artifact@1.0.0
+      # --- Release Branch Commit ---
+      - name: Commit and push release branch
+        run: |
+          git config user.name "CI Release Bot"
+          git config user.email "ci@helsingborg.se"
+          git checkout -B release
+          git add -A
+          git commit -m "Release build from $GITHUB_SHA" || echo "No changes to commit"
+          git push origin release --force
+
+      # --- Tag and create GitHub Release on release branch ---
+      - name: Create and push tag
+        run: |
+          TAG="${{ steps.version.outputs.version }}"
+          # skip if tag already exists
+          if git ls-remote --tags origin | grep -q "refs/tags/$TAG$"; then
+            echo "Tag $TAG already exists, skipping tag creation."
+            exit 0
+          fi
+          git tag "$TAG"
+          git push origin "$TAG"
+
+      - name: Wait for tag propagation
+        run: sleep 5
+
+      - name: Create GitHub Release
+        uses: ncipollo/release-action@v1
         with:
-          artifact: "release.zip"
-          gh_token: ${{ secrets.GITHUB_TOKEN }}
-          release: ${{ env.LATEST_RELEASE }}
-          repo: ${{ github.repository }}
-          artifact_mime_type: application/zip
+          tag: ${{ steps.version.outputs.version }}
+          generateReleaseNotes: true
diff --git a/build.php b/build.php
@@ -6,9 +6,10 @@
 }
 
 /* Parameters: 
- --no-composer      Does not install vendors. Just create the autoloader.
- --cleanup          Remove removeables. 
- --allow-gulp       Allow gulp to be used. 
+ --no-composer      Does not install vendors via composer
+ --cleanup          Remove removeables
+ --install-npm      Installs npm package as per package.json name field
+ --release          Does not run composer install and does not remove .git
 */
 
 // Any command needed to run and build plugin assets when newly cheched out of repo.
@@ -17,57 +18,70 @@
 //Add composer build, if flag --no-composer is undefined.
 //Dump autloader. 
 //Only if composer.json exists.
-if(file_exists('composer.json')) {
-    if(is_array($argv) && !in_array('--no-composer', $argv)) {
-        $buildCommands[] = 'composer install --prefer-dist --no-progress --no-dev'; 
+if (file_exists('composer.json')) {
+    if (is_array($argv) && !in_array('--no-composer', $argv)) {
+        $buildCommands[] = 'composer install --prefer-dist --no-progress --no-dev';
     }
+
     $buildCommands[] = 'composer dump-autoload';
 }
 
 //Run npm if package.json is found
-if(file_exists('package.json') && file_exists('package-lock.json')) {
-    $buildCommands[] = 'npm ci --no-progress --no-audit';
-} elseif(file_exists('package.json') && !file_exists('package-lock.json')) {
-    $buildCommands[] = 'npm install --no-progress --no-audit';
-}
-
-//Run build if package-lock.json is found
-if(file_exists('package-lock.json') && !file_exists('gulp.js')) {
-    $buildCommands[] = 'npx --yes browserslist@latest --update-db';
-    $buildCommands[] = 'npm run build';
-} elseif(file_exists('package-lock.json') && file_exists('gulp.js') && is_array($argv) && in_array('--allow-gulp', $argv)) {
-    $buildCommands[] = 'gulp';
+if (file_exists('package.json') && file_exists('package-lock.json')) {
+    if (is_array($argv) && !in_array('--install-npm', $argv)) {
+        $buildCommands[] = 'npm ci --no-progress --no-audit';
+        $buildCommands[] = 'npm run build';
+    } else {
+        $npmPackage = json_decode(file_get_contents('package.json'));
+        $buildCommands[] = "npm install $npmPackage->name";
+        $buildCommands[] = "rm -rf ./dist";
+        $buildCommands[] = "mv node_modules/$npmPackage->name/dist ./";
+    }
+} elseif (file_exists('package.json') && !file_exists('package-lock.json')) {
+    if (is_array($argv) && !in_array('--install-npm', $argv)) {
+        $buildCommands[] = 'npm install --no-progress --no-audit';
+        $buildCommands[] = 'npm run build';
+    } else {
+        $npmPackage = json_decode(file_get_contents('package.json'));
+        $buildCommands[] = "npm install $npmPackage->name";
+        $buildCommands[] = "rm -rf ./dist";
+        $buildCommands[] = "mv node_modules/$npmPackage->name/dist ./";
+    }
 }
 
 // Files and directories not suitable for prod to be removed.
 $removables = [
-    '.git',
     '.gitignore',
     '.github',
     '.gitattributes',
     'build.php',
+    'build.js',
     '.npmrc',
-    'composer.json',
+    //'composer.json',
     'composer.lock',
     'env-example',
     'webpack.config.js',
     'package-lock.json',
     'package.json',
     'phpunit.xml.dist',
     'README.md',
-    'gulpfile.js',
     './node_modules/',
     './source/sass/',
     './source/js/',
     'LICENSE',
     'babel.config.js',
     'yarn.lock',
+    '.devcontainer',
     'vite.config.mjs',
     'tsconfig.json',
     'mago.toml',
     '.vscode',
 ];
 
+if (is_array($argv) && !in_array('--release', $argv)) {
+    $removables = array_merge($removables, ['.git']);
+}
+
 $dirName = basename(dirname(__FILE__));
 
 // Run all build commands.
@@ -78,14 +92,14 @@
     $timeStart = microtime(true);
     $exitCode = executeCommand($buildCommand);
     $buildTime = round(microtime(true) - $timeStart);
-    print "---- Done build command '$buildCommand' for $dirName.  Build time: $buildTime seconds. ----\n";
+    print "---- Done build command '$buildCommand' for $dirName.  Build time: $buildTime seconds. ----\n\n";
     if ($exitCode > 0) {
         exit($exitCode);
     }
 }
 
 // Remove files and directories if '--cleanup' argument is supplied to save local developers from disasters.
-if(is_array($argv) && in_array('--cleanup', $argv)) {
+if (is_array($argv) && in_array('--cleanup', $argv)) {
     foreach ($removables as $removable) {
         if (file_exists($removable)) {
             print "Removing $removable from $dirName\n";
@@ -117,7 +131,7 @@ function executeCommand($command)
         $liveOutput     = fread($proc, 4096);
         $completeOutput = $completeOutput . $liveOutput;
         print $liveOutput;
-        @ flush();
+        @flush();
     }
 
     pclose($proc);
