diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml index 1e6cb4b4..1e78392d 100644 --- a/.github/workflows/coding-standards.yml +++ b/.github/workflows/coding-standards.yml @@ -4,13 +4,25 @@ on: pull_request: branches: - "*.x" + paths: + - ".github/workflows/coding-standards.yml" + - "composer.*" + - "src/**" + - "phpcs.xml.dist" + - "tests/**" push: branches: - "*.x" + paths: + - ".github/workflows/coding-standards.yml" + - "composer.*" + - "src/**" + - "phpcs.xml.dist" + - "tests/**" jobs: coding-standards: name: "Coding Standards" - uses: "doctrine/.github/.github/workflows/coding-standards.yml@2.1.0" + uses: "doctrine/.github/.github/workflows/coding-standards.yml@6.0.0" with: - php-version: '8.3' + php-version: "8.3" diff --git a/.github/workflows/composer-lint.yml b/.github/workflows/composer-lint.yml index fbb79959..39e14e0c 100644 --- a/.github/workflows/composer-lint.yml +++ b/.github/workflows/composer-lint.yml @@ -5,16 +5,18 @@ on: branches: - "*.x" paths: + - ".github/workflows/composer-lint.yml" - "composer.json" push: branches: - "*.x" paths: + - ".github/workflows/composer-lint.yml" - "composer.json" jobs: composer-lint: name: "Composer Lint" - uses: "doctrine/.github/.github/workflows/composer-lint.yml@2.1.0" + uses: "doctrine/.github/.github/workflows/composer-lint.yml@6.0.0" with: php-version: "8.3" diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index 68ee85b1..6e4b5e05 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -4,13 +4,27 @@ on: pull_request: branches: - "*.x" + paths: + - ".github/workflows/continuous-integration.yml" + - "composer.*" + - "src/**" + - "phpunit.xml.dist" + - "tests/**" push: branches: - "*.x" + paths: + - ".github/workflows/continuous-integration.yml" + - "composer.*" + - "src/**" + - "phpunit.xml.dist" + - "tests/**" jobs: phpunit: name: "PHPUnit" - uses: "doctrine/.github/.github/workflows/continuous-integration.yml@2.1.0" + uses: "doctrine/.github/.github/workflows/continuous-integration.yml@6.0.0" with: php-versions: '["8.1", "8.2", "8.3"]' + secrets: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..84bf616c --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,20 @@ +name: "Documentation" + +on: + pull_request: + branches: + - "*.x" + paths: + - ".github/workflows/documentation.yml" + - "docs/**" + push: + branches: + - "*.x" + paths: + - ".github/workflows/documentation.yml" + - "docs/**" + +jobs: + documentation: + name: "Documentation" + uses: "doctrine/.github/.github/workflows/documentation.yml@6.0.0" diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml new file mode 100644 index 00000000..f1e6edc2 --- /dev/null +++ b/.github/workflows/phpstan.yml @@ -0,0 +1,28 @@ +name: "Static Analysis" + +on: + pull_request: + branches: + - "*.x" + paths: + - ".github/workflows/phpstan.yml" + - "composer.*" + - "src/**" + - "phpstan*" + - "tests/**" + push: + branches: + - "*.x" + paths: + - ".github/workflows/phpstan.yml" + - "composer.*" + - "src/**" + - "phpstan*" + - "tests/**" + +jobs: + static-analysis: + name: "Static Analysis" + uses: "doctrine/.github/.github/workflows/phpstan.yml@6.0.0" + with: + php-version: "8.3" diff --git a/.github/workflows/release-on-milestone-closed.yml b/.github/workflows/release-on-milestone-closed.yml index 2f4f9622..6f621466 100644 --- a/.github/workflows/release-on-milestone-closed.yml +++ b/.github/workflows/release-on-milestone-closed.yml @@ -8,11 +8,11 @@ on: jobs: release: name: "Git tag, release & create merge-up PR" - uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@2.1.0" - with: - use-next-minor-as-default-branch: true + uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@6.0.0" secrets: GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }} GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }} ORGANIZATION_ADMIN_TOKEN: ${{ secrets.ORGANIZATION_ADMIN_TOKEN }} SIGNING_SECRET_KEY: ${{ secrets.SIGNING_SECRET_KEY }} + with: + use-next-minor-as-default-branch: true # defaults to false diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml deleted file mode 100644 index 1e6a932d..00000000 --- a/.github/workflows/static-analysis.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: "Static Analysis" - -on: - pull_request: - branches: - - "*.x" - push: - branches: - - "*.x" - -jobs: - static-analysis: - name: "Static Analysis" - uses: "doctrine/.github/.github/workflows/static-analysis.yml@2.1.0" - with: - php-version: '8.3' diff --git a/.gitignore b/.gitignore index 6cc8134c..34669ade 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ /composer.lock /phpcs.xml /phpunit.xml +/output/ /vendor/ diff --git a/composer.json b/composer.json index 12ad5ffc..0656ba91 100644 --- a/composer.json +++ b/composer.json @@ -70,6 +70,7 @@ "laminas/laminas-log": "^2.15.3", "laminas/laminas-serializer": "^2.13.0", "laminas/laminas-session": "^2.13.0", + "phpdocumentor/guides-cli": "^1.5.0", "phpstan/phpstan": "^1.9.2", "phpstan/phpstan-phpunit": "^1.3.0", "phpunit/phpunit": "^9.5.27", diff --git a/docs/en/index.rst b/docs/en/index.rst index 5ec2ad00..eb5c2666 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -54,3 +54,14 @@ You can find more details about the features offered by DoctrineModule: this chapter explains how to use ObjectExists and NoObjectExists validator, that allow you to easily validate if a given entity exists or not. + + +.. toctree:: + :caption: Table of Contents + + authentication + caching + cli + form-element + paginator + validator diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index 49edc9a2..e699d71a 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,3 +1,4 @@ +:orphan: .. toctree:: :depth: 3