feat(ci): migrate php checks , docs, and php unit tests from Drone to GitHub Actions
#294
+149
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
| workflow_dispatch: | ||
|
|
||
| env: | ||
| COMPOSER_HOME: ${{ github.workspace }}/.cache/composer | ||
| DEFAULT_PHP_VERSION: '8.1' | ||
|
|
||
| jobs: | ||
| php-checks: | ||
| name: PHP checks | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2.37.0 | ||
| with: | ||
| php-version: ${{ env.DEFAULT_PHP_VERSION }} | ||
| tools: composer:72a8f8e653710e18d83e5dd531eb5a71fc3223e6 # v2.9.5 | ||
|
|
||
| - uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4 | ||
| with: | ||
| path: .cache/composer | ||
| key: composer-${{ hashFiles('composer.lock') }} | ||
|
|
||
| - run: composer install | ||
|
|
||
| - name: codeStyle | ||
| run: make test-php-style | ||
|
|
||
| - name: phpStan | ||
| run: make test-php-phpstan | ||
|
|
||
| - name: phpPhan | ||
| run: make test-php-phan | ||
|
|
||
| php-unit-tests-without-coverage: | ||
| name: php unit tests ${{ matrix.php-version}} without coverage | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| php-version : ['8.1', '8.2', '8.3'] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2.37.0 | ||
| with: | ||
| php-version: ${{ matrix.php-version }} | ||
| tools: composer:72a8f8e653710e18d83e5dd531eb5a71fc3223e6 # v2.9.5 | ||
| coverage: xdebug | ||
|
|
||
| - uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4 | ||
| with: | ||
| path: .cache/composer | ||
| key: composer-${{ hashFiles('composer.lock') }} | ||
|
|
||
| - run: composer install | ||
|
|
||
| - name: unitTests-${{ matrix.php-version }} | ||
| run: make test-php-unit | ||
|
|
||
| php-unit-tests-with-coverage: | ||
| name: php unit tests ${{ matrix.php-version}} with coverage | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| php-version : ['8.1', '8.2', '8.3'] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2.37.0 | ||
| with: | ||
| php-version: ${{ matrix.php-version }} | ||
| tools: composer:72a8f8e653710e18d83e5dd531eb5a71fc3223e6 # v2.9.5 | ||
| coverage: xdebug | ||
|
|
||
| - uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4 | ||
| with: | ||
| path: .cache/composer | ||
| key: composer-${{ hashFiles('composer.lock') }} | ||
|
|
||
| - run: composer install | ||
|
|
||
| - name: unitTests-${{ matrix.php-version }} | ||
| run: make test-php-unit | ||
|
|
||
| - name: coverage rename | ||
| run: mv tests/output/clover.xml tests/output/clover-unitTests-${{ matrix.php-version }}.xml | ||
|
|
||
| - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 | ||
| with: | ||
| name: coverage-unitTests-${{ matrix.php-version }} | ||
| path: tests/output/clover-unitTests-${{ matrix.php-version }}.xml | ||
|
|
||
| docs: | ||
| name: docs | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2.37.0 | ||
| with: | ||
| php-version: ${{ env.DEFAULT_PHP_VERSION }} | ||
| tools: composer:72a8f8e653710e18d83e5dd531eb5a71fc3223e6 # v2.9.5 | ||
| coverage: none | ||
|
|
||
| - uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4 | ||
| with: | ||
| path: .cache/composer | ||
| key: composer-${{ hashFiles('composer.lock') }} | ||
|
|
||
| - run: composer install | ||
|
|
||
| - name: docs generate | ||
| uses: docker://phpdoc/phpdoc:3 | ||
|
Member
There was a problem hiding this comment. using docker image. needs to clarify if this is ok.
Member
There was a problem hiding this comment. please see if any of these fits the needs https://github.com/marketplace?query=phpdoc&type=actions |
||
|
|
||
| - name: publish api docs | ||
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | ||
|
Member
There was a problem hiding this comment. |
||
| if: github.event_name != 'pull_request' | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: docs | ||
| publish_branch: docs | ||
| force_orphan: true | ||
|
|
||
| - name: compile docs hugo | ||
| run: | | ||
| mkdir docs-hugo | ||
| cat docs-hugo-header.md README.md > docs-hugo/_index.md | ||
|
|
||
| - name: publish docs hugo | ||
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | ||
| if: github.event_name != 'pull_request' | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: docs-hugo | ||
| publish_branch: docs-hugo | ||
| force_orphan: true | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
most commonly used php setup but not verified.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc: @DeepDiver1975
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See https://github.com/owncloud/reusable-workflows/blob/main/.github/workflows/php-unit.yml
and any other workflows in that folder. Those are being used with ownCloud core and apps.
Use anything from there as examples.
I don't think that we will be using https://github.com/owncloud-ci/php because actually we are easily using shivammathur/setup-php to get and configure PHP.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
github.com/owncloud/impersonate/pull/256 has GitHub workflow actions that I am doing for ownCloud core and apps. So look there also to get any ideas.