Files
opensourcepos/.github/workflows
e20fb2a792 feat(db): add MySQL 8.4 support (#4048)
Add MySQL 8.4 compatibility, including a utf8mb4 conversion migration,
hardened foreign key handling, and expanded CI database coverage.

Migrations:
- Add Mysql84Utf8mb4Conversion migration using
  sqlscripts/3.4.3_mysql84_utf8mb4_conversion.sql via executeScript()
- Drop ospos_people composite index before conversion, since its
  prefix length exceeds the 3072-byte key limit under utf8mb4
- Add assertNoCollationCollisions() pre-flight check to fail fast on
  unique values that collide under utf8mb4_unicode_520_ci, instead of
  hitting "Duplicate entry" partway through ALTER TABLE
- Wrap the conversion in try/catch so foreign keys are recreated on
  failure; log restore errors separately so they don't mask the
  original exception
- Throw RuntimeException if re-adding the people index fails
- Remove the re-add of the sales_items_taxes FK in down(), which
  MySQL 8.4 rejects without a unique key
- Revert edits to historical migrations; fix FK handling and table
  names

migration_helper:
- Add shared dropAllForeignKeyConstraints() and
  recreateForeignKeyConstraints(); table/column now optional, dropping
  all FKs in the schema when omitted
- Match CONSTRAINT_SCHEMA when joining KEY_COLUMN_USAGE to
  REFERENTIAL_CONSTRAINTS to avoid cross-schema name collisions
- Rebuild FK lookup with the query builder and bound values instead
  of interpolated SQL

CI/tests:
- Add mysql:5.7, mariadb:10.6 and mariadb:10.11 to PHPUnit matrix
- Use master instead of latest image tag; improve CI robustness
- Mock table() in FailedQueryConnectionTrait so query builder chains
  work against the failing connection

Signed-off-by: objecttothis <17935339+objecttothis@users.noreply.github.com>
Co-authored-by: aliworksx08 <57456290+aliworksx08@users.noreply.github.com>
Co-authored-by: jekkos <jeroen.peelaerts@gmail.com>
Co-authored-by: objecttothis <17935339+objecttothis@users.noreply.github.com>
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-19 14:24:51 +04:00
..
2026-04-14 01:05:10 +04:00

GitHub Actions

This document describes the CI/CD workflows for OSPOS.

Build and Release Workflow (.github/workflows/build-release.yml)

Build Process

  • Setup PHP 8.2 with required extensions
  • Setup Node.js 22
  • Install composer dependencies
  • Install npm dependencies
  • Build frontend assets with Gulp

Docker Images

  • Build and push opensourcepos Docker image for multiple architectures (linux/amd64, linux/arm64)
  • On master: tagged master and <sha>
  • On other branches: tagged <branch>-<sha>
  • On a semver tag (e.g. 3.4.2): tagged <version> and latest
  • The version number is never stamped onto master/branch builds — it only appears on tag releases
  • Pushed to Docker Hub

Releases

  • Create distribution archives (tar.gz, zip)
  • Create/update GitHub "unstable" release on master branch only

Required Secrets

To use this workflow, you need to add the following secrets to your repository:

  1. DOCKER_USERNAME - Docker Hub username for pushing images
  2. DOCKER_PASSWORD - Docker Hub password/token for pushing images

How to add secrets

  1. Go to your repository on GitHub
  2. Click Settings → Secrets and variables → Actions
  3. Click New repository secret
  4. Add DOCKER_USERNAME and DOCKER_PASSWORD

The GITHUB_TOKEN is automatically provided by GitHub Actions.

Workflow Triggers

  • Push to master - Runs build, Docker push (master + <sha> tags), and creates/updates the unstable release
  • Push to other branches - Runs build and Docker push (<branch>-<sha> tag)
  • Push a semver tag (e.g. 3.4.2) - Runs build and Docker push (<version> + latest tags)
  • Pull requests - Runs build only (PHPUnit tests run in parallel via phpunit.yml); no Docker push

Existing Workflows

This repository also has these workflows:

  • .github/workflows/main.yml - PHP linting with PHP-CS-Fixer
  • .github/workflows/phpunit.yml - PHPUnit tests (runs on all PHP versions 8.1-8.4)
  • .github/workflows/php-linter.yml - PHP linting

Testing

PHPUnit tests are run separately via .github/workflows/phpunit.yml on every push and pull request, testing against PHP 8.1, 8.2, 8.3, and 8.4.

To test the build workflow:

  1. Add the required secrets
  2. Push to master or create a PR
  3. Monitor the Actions tab in GitHub