Merge branch 'release/1.2.25' into v1

Author: khalwat

.github/workflows/build-and-deploy-docs.yml

@@ -22,11 +22,11 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        node-version: [ 14.x ]
+        node-version: [ 20.x ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci

.github/workflows/code-analysis.yaml

@@ -0,0 +1,40 @@
+name: Code Analysis
+
+on:
+  pull_request: null
+  push:
+    branches:
+      - develop
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  code_analysis:
+    strategy:
+      fail-fast: false
+      matrix:
+        actions:
+          - name: 'PHPStan'
+            run: composer phpstan
+          - name: 'Coding Standards'
+            run: composer fix-cs
+    name: ${{ matrix.actions.name }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
+      - name: Setup PHP
+        id: setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: 'ctype,curl,dom,iconv,imagick,intl,json,mbstring,openssl,pcre,pdo,reflection,spl,zip'
+          ini-values: post_max_size=256M, max_execution_time=180, memory_limit=512M
+          tools: composer:v2
+      - name: Install Composer dependencies
+        run: composer install --no-interaction --no-ansi --no-progress
+      - run: ${{ matrix.actions.run }}

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Transcoder Changelog
 
+## 1.2.25 - 2024.09.30
+## Added
+* Add `phpstan` and `ecs` code linting
+* Add `code-analysis.yaml` GitHub action
+
 ## 1.2.24 - 2023.04.20
 ### Changed
 * Updated the docs to use VitePress `^1.0.0-alpha.29`

Makefile

@@ -0,0 +1,28 @@
+MAJOR_VERSION?=3
+PLUGINDEV_PROJECT_DIR?=/Users/andrew/webdev/sites/plugindev/cms_v${MAJOR_VERSION}/
+VENDOR?=nystudio107
+PROJECT_PATH?=${VENDOR}/$(shell basename $(CURDIR))
+
+.PHONY: dev docs release
+
+# Start up the buildchain dev server
+dev:
+	${MAKE} -C buildchain/ dev
+# Start up the docs dev server
+docs:
+	${MAKE} -C docs/ dev
+# Run code quality tools, tests, and build the buildchain & docs in preparation for a release
+release: --code-quality --code-tests --buildchain-clean-build --docs-clean-build
+# The internal targets used by the dev & release targets
+--buildchain-clean-build:
+	${MAKE} -C buildchain/ clean
+	${MAKE} -C buildchain/ image-build
+	${MAKE} -C buildchain/ build
+--code-quality:
+	${MAKE} -C ${PLUGINDEV_PROJECT_DIR} -- ecs check vendor/${PROJECT_PATH}/src --fix
+	${MAKE} -C ${PLUGINDEV_PROJECT_DIR} -- phpstan analyze -c vendor/${PROJECT_PATH}/phpstan.neon
+--code-tests:
+--docs-clean-build:
+	${MAKE} -C docs/ clean
+	${MAKE} -C docs/ image-build
+	${MAKE} -C docs/ fix

buildchain/.gitignore

@@ -0,0 +1,28 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Misc directories & files
+coverage/*
+.stylelintcache

buildchain/Dockerfile

@@ -1,7 +1,7 @@
-ARG TAG=16-alpine
-FROM nystudio107/node-dev-base:$TAG
+ARG TAG=20-alpine
+FROM node:$TAG
 
-USER node
+RUN npm install -g npm@^10.0.0
 
 WORKDIR /app/buildchain/
 

buildchain/Makefile

@@ -1,43 +1,39 @@
-TAG?=16-alpine
-CONTAINER?=$(shell basename $(dir $(CURDIR)))-buildchain
-DOCKERRUN=docker container run \
-	--name ${CONTAINER} \
-	--rm \
-	-t \
-	--network plugindev_default \
-	-p 3001:3001 \
-	-v "${CURDIR}"/../:/app \
-	${CONTAINER}:${TAG}
+MAJOR_VERSION?=3
+TAG?=20-alpine
+CONTAINER?=$(shell basename $(dir $(CURDIR)))-v${MAJOR_VERSION}-buildchain
+DEV_PORT?=300${MAJOR_VERSION}
+IMAGE_INFO=$(shell docker image inspect $(CONTAINER):$(TAG))
+IMAGE_NAME=${CONTAINER}:${TAG}
+DOCKER_NETWORK?=plugindev_default
+DOCKER_RUN=docker container run --rm -it --network "${DOCKER_NETWORK}" -v "${CURDIR}"/../:/app
 
-.PHONY: build dev docker install clean npm
+.PHONY: build clean dev image-build image-check npm ssh
 
-# Build the production assets
-build: docker install
-	${DOCKERRUN} \
-		run build
-# Start up the dev server
-dev: docker install
-	${DOCKERRUN} \
-		run dev
-# Start the Docker container
-docker:
-	docker build \
-		. \
-		-t ${CONTAINER}:${TAG} \
-		--build-arg TAG=${TAG} \
-		--no-cache
-# Run an npm install
-install: docker
-	${DOCKERRUN} \
-		install
-# Remove node_modules/* & package-lock.json
+# Perform a dist build via npm run build
+build: image-check
+	${DOCKER_RUN} --name ${CONTAINER}-$@ ${IMAGE_NAME} run build
+# Remove node_modules/ & package-lock.json
 clean:
 	rm -rf node_modules/
 	rm -f package-lock.json
+# Run the development server via npm run dev
+dev: image-check
+	${DOCKER_RUN} --name ${CONTAINER}-$@ -e DEV_PORT="${DEV_PORT}" -p ${DEV_PORT}:${DEV_PORT} ${IMAGE_NAME} run dev
+# Build the Docker image & run npm install
+image-build:
+	docker build . -t ${IMAGE_NAME} --build-arg TAG=${TAG} --no-cache
+	${DOCKER_RUN} --name ${CONTAINER}-$@ ${IMAGE_NAME} install
+# Ensure the image has been created
+image-check:
+ifeq ($(IMAGE_INFO), [])
+image-check: image-build
+endif
 # Run the passed in npm command
-npm: docker
-	${DOCKERRUN} \
-		$(filter-out $@,$(MAKECMDGOALS))
+npm: image-check
+	${DOCKER_RUN} --name ${CONTAINER}-$@ ${IMAGE_NAME} $(filter-out $@,$(MAKECMDGOALS)) $(MAKEFLAGS)
+# Open a shell inside of the container
+ssh: image-check
+	${DOCKER_RUN} --name ${CONTAINER}-$@ --entrypoint=/bin/sh ${IMAGE_NAME}
 %:
 	@:
 # ref: https://stackoverflow.com/questions/6273608/how-to-pass-argument-to-makefile-from-command-line