Merge pull request #1523 from xwp/release/4.0.1

Release `4.0.1`

.distignore

@@ -0,0 +1,24 @@
+.coveralls.yml
+.distignore
+.editorconfig
+.eslintignore
+.eslintrc.json
+.gitignore
+.nvmrc
+composer.lock
+docker-compose.build.yml
+docker-compose.yml
+Gruntfile.js
+package.json
+package-lock.json
+phpcs.xml.dist
+phpunit.xml
+phpunit-multisite.xml
+renovate.json
+.git
+.github
+.vscode
+.wordpress-org
+local
+node_modules
+tests

.github/workflows/ci.yml

@@ -7,13 +7,16 @@ jobs:
   lint:
     name: Lint and Test
     runs-on: ubuntu-22.04
+    permissions:
+      contents: read
+      packages: read
     steps:
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'
@@ -24,6 +27,24 @@ jobs:
           php-version: '8.1'
           tools: composer:v2
 
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache Composer packages
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-php-${{ hashFiles( 'composer.lock' ) }}
+          restore-keys: ${{ runner.os }}-php-
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Install NPM dependencies
         run: npm install
 
@@ -33,11 +54,11 @@ jobs:
       - name: Lint
         run: npm run lint
 
-      - name: Pull Docker Images
-        run: docker-compose pull wordpress
+      - name: Pull custom Docker images
+        run: docker compose pull wordpress
 
-      - name: Test PHP
-        run: npm run phpunit
+      - name: Test
+        run: npm run test
 
       - name: Build
         run: npm run build

.github/workflows/deploy-to-wp-org.yml

@@ -0,0 +1,95 @@
+name: Deploy to WordPress.org Repository
+
+on:
+
+  # The action will run when a release or a pre-release is created.
+  #
+  # In case of a pre-release, the action will not commit to WP.org (dry-run). However, it will still
+  # create a zip file and upload it to the release. Note that a pre-release (release candidate)
+  # should not be changed to a release but rather a new release should be created.
+  release:
+    types:
+      - released
+      - prereleased
+
+jobs:
+
+  deploy_to_wp_repository:
+    name: Deploy to WP.org
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+      packages: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: composer:v2
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache Composer packages
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-php-${{ hashFiles( 'composer.lock' ) }}
+          restore-keys: ${{ runner.os }}-php-
+
+      # Install dependencies.
+      - name: Install NPM dependencies
+        run: npm install
+
+      - name: Install Composer dependencies
+        run: composer install --no-dev
+
+      # Build.
+      - name: Build
+        run: npm run build
+
+      - name: WordPress Plugin Deploy
+        # This is used to get the zip-path later.
+        id: deploy
+        uses: 10up/action-wordpress-plugin-deploy@stable
+        with:
+          generate-zip: true
+          # In case of a pre-release, do not commit to WP.org.
+          dry-run: ${{ github.event.release.prerelease }}
+
+        # Use secrets to authenticate with WP.org.
+        env:
+          SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
+          SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
+
+      # After the deployment, we also want to create a zip and upload it to the release on GitHub.
+      - name: Upload release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          # Note, this is an exception to action secrets: GITHUB_TOKEN is always available and provides access to
+          # the current repository this action runs in.
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        with:
+          # Get the URL for uploading assets to the current release.
+          upload_url: ${{ github.event.release.upload_url }}
+
+          # Provide the path to the file generated in the previous step using the output.
+          asset_path: ${{ steps.deploy.outputs.zip-path }}
+
+          # Provide what the file should be named when attached to the release (plugin-name.zip)
+          asset_name: ${{ github.event.repository.name }}.zip
+
+          # Provide the file type.
+          asset_content_type: application/zip

.github/workflows/docker-images.yml

@@ -0,0 +1,40 @@
+name: Build and Publish Docker Images
+
+on:
+  push:
+    paths:
+      - '.github/workflows/docker-images.yml'
+      - 'docker-compose.yml'
+      - 'docker-compose.build.yml'
+      - 'local/docker/**'
+
+jobs:
+
+  build-and-push-image:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build images
+        run: docker compose --file docker-compose.build.yml build
+
+      - name: Publish images
+        if: contains( github.ref_name, 'master' )
+        run: docker buildx bake --file docker-compose.build.yml --push --set '*.platform=linux/amd64,linux/arm64'

.gitignore

@@ -5,15 +5,19 @@
 /vendor/
 /build/
 /dist/
-/.vagrant/
 /console.log
 /phpcs.xml
 /stream.zip
 /stream-*.zip
 npm-debug.log
+debug.log
 package.lock
+.phpunit.result.cache
 
 # Compiled files
 ui/js/*.min.js
 ui/css/*.min.css
 alerts/js/*.min.js
+
+# Generated test data
+tests/data/tmp/*

.nvmrc

@@ -1 +1 @@
-16
+20

.vscode/launch.json

@@ -5,14 +5,14 @@
       "name": "Listen for Stream XDebug",
       "type": "php",
       "request": "launch",
-      "port": 9000,
+      "port": 9003,
       "ignore": [
         "vendor/"
       ],
       "pathMappings": {
-        "/var/www/html/wp-content/plugins/stream-src": "${workspaceRoot}",
-        "/var/www/html/wp-content/plugins/stream": "${workspaceRoot}/build",
-        "/var/www/html": "${workspaceRoot}/local/public"
+        "/var/www/html/wp-content/plugins/stream-src": "${workspaceFolder}",
+        "/var/www/html/wp-content/plugins/stream": "${workspaceFolder}/build",
+        "/var/www/html": "${workspaceFolder}/local/public"
       }
     }
   ]