docs: update README.md

2026-05-17 17:28:03 +00:00 · 2026-01-23 18:47:53 +02:00
parent 0808232cc6
commit e203813f6f
1 changed files with 194 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -72,6 +72,200 @@ jobs:
      REPO_DISPATCH_PAT: ${{ secrets.REPO_DISPATCH_PAT }}
 ```

+---
+
+## Nextcloud Workflows
+
+Reusable workflows for Nextcloud app development. These workflows include automatic path filtering to skip unnecessary runs when irrelevant files change.
+
+### PHPUnit MySQL (`nextcloud-phpunit-mysql.yml`)
+
+Runs PHPUnit tests with MySQL database.
+
+```yaml
+jobs:
+  phpunit:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-phpunit-mysql.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `php-versions-min` | Minimum PHP version | `8.2` |
+| `php-versions-max` | Maximum PHP version | `8.3` |
+| `mysql-version` | MySQL version | `8.4` |
+| `php-extensions` | PHP extensions to install | _(common extensions)_ |
+| `path-filters` | Paths to trigger on (YAML list) | _(lib, tests, etc.)_ |
+
+### PHPUnit PostgreSQL (`nextcloud-phpunit-pgsql.yml`)
+
+Runs PHPUnit tests with PostgreSQL database.
+
+```yaml
+jobs:
+  phpunit:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-phpunit-pgsql.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `php-version` | PHP version | `8.3` |
+| `php-extensions` | PHP extensions to install | _(common extensions)_ |
+| `path-filters` | Paths to trigger on (YAML list) | _(lib, tests, etc.)_ |
+
+### PHPUnit Incremental Migration (`nextcloud-phpunit-incremental.yml`)
+
+Tests database migrations by upgrading from a baseline version.
+
+```yaml
+jobs:
+  incremental:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-phpunit-incremental.yml@nextcloud-latest
+    with:
+      baseline-version: v1.0.0
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `baseline-version` | Git tag/ref to upgrade from | **Required** |
+| `php-version` | PHP version | `8.3` |
+| `validation-query` | SQL query to validate migration | _(empty)_ |
+| `path-filters` | Paths to trigger on (YAML list) | _(lib, tests, etc.)_ |
+
+### Psalm Static Analysis (`nextcloud-psalm.yml`)
+
+Runs Psalm static analysis across supported Nextcloud versions.
+
+```yaml
+jobs:
+  psalm:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-psalm.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `psalm-command` | Command to run Psalm | `composer run psalm` |
+| `php-extensions` | PHP extensions to install | _(common extensions)_ |
+| `path-filters` | Paths to trigger on (YAML list) | `**.php`, `psalm.xml` |
+
+### PHP Lint (`nextcloud-lint-php.yml`)
+
+Runs PHP syntax linting across supported PHP versions.
+
+```yaml
+jobs:
+  lint:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-lint-php.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `lint-command` | Command to run lint | `composer run lint` |
+| `php-extensions` | PHP extensions to install | _(common extensions)_ |
+| `path-filters` | Paths to trigger on (YAML list) | `**.php` |
+
+### PHP-CS-Fixer (`nextcloud-lint-php-cs.yml`)
+
+Checks PHP code style with PHP-CS-Fixer.
+
+```yaml
+jobs:
+  cs:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-lint-php-cs.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `cs-check-command` | Command to check code style | `composer run cs:check` |
+| `php-extensions` | PHP extensions to install | _(common extensions)_ |
+| `path-filters` | Paths to trigger on (YAML list) | `**.php`, `.php-cs-fixer.dist.php` |
+
+### ESLint (`nextcloud-lint-eslint.yml`)
+
+Runs ESLint on frontend code.
+
+```yaml
+jobs:
+  eslint:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-lint-eslint.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `lint-command` | Command to run lint | `pnpm lint` |
+| `path-filters` | Paths to trigger on (YAML list) | `src/**`, `*.ts`, `*.js`, etc. |
+
+### OpenAPI Lint (`nextcloud-lint-openapi.yml`)
+
+Validates OpenAPI spec is up to date.
+
+```yaml
+jobs:
+  openapi:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-lint-openapi.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `openapi-command` | Command to regenerate OpenAPI | `composer run openapi` |
+| `typescript-types-pattern` | Glob for TypeScript types | `src/types/openapi/openapi*.ts` |
+| `path-filters` | Paths to trigger on (YAML list) | `lib/**/*.php`, `openapi.json` |
+
+### AppInfo XML Lint (`nextcloud-lint-appinfo-xml.yml`)
+
+Validates `appinfo/info.xml` against schema.
+
+```yaml
+jobs:
+  xml:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-lint-appinfo-xml.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `schema-url` | URL to XML schema | _(Nextcloud schema)_ |
+| `path-filters` | Paths to trigger on (YAML list) | `appinfo/info.xml` |
+
+### NPM Build (`nextcloud-build-npm.yml`)
+
+Builds frontend assets with pnpm.
+
+```yaml
+jobs:
+  build:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-build-npm.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `path-filters` | Paths to trigger on (YAML list) | `src/**`, `*.json`, etc. |
+
+### Vitest (`nextcloud-vitest.yml`)
+
+Runs Vitest frontend tests.
+
+```yaml
+jobs:
+  vitest:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-vitest.yml@nextcloud-latest
+```
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `vitest-command` | Command to run Vitest | `pnpm vitest` |
+| `path-filters` | Paths to trigger on (YAML list) | `src/**`, `*.ts`, etc. |
+
+### Block Unconventional Commits (`nextcloud-block-unconventional-commits.yml`)
+
+Blocks commits that don't follow conventional commit format.
+
+```yaml
+jobs:
+  commits:
+    uses: chenasraf/workflows/.github/workflows/nextcloud-block-unconventional-commits.yml@nextcloud-latest
+```
+
+---
+
 ## License

 MIT