docs: Improve Contributing Guide (#508) #10
This file contains 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
| name: release-automated | |
| on: | |
| push: | |
| branches: [ master, release, alpha, beta ] | |
| env: | |
| NODE_VERSION: 18 | |
| PHP_VERSION: 8.1 | |
| jobs: | |
| release: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| current_tag: ${{ steps.tag.outputs.current_tag }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - run: npm ci | |
| - run: npx semantic-release | |
| env: | |
| GH_TOKEN: ${{ secrets.RELEASE_GITHUB_TOKEN }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Determine tag on current commit | |
| id: tag | |
| run: echo "::set-output name=current_tag::$(git describe --tags --abbrev=0 --exact-match || echo '')" | |
| docs-publish: | |
| needs: release | |
| if: needs.release.outputs.current_tag != '' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: ${{ needs.release.outputs.current_tag }} | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Setup PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ env.PHP_VERSION }} | |
| - name: Generate Docs | |
| run: | | |
| composer install | |
| npm run document-check | |
| npm run document | |
| env: | |
| SOURCE_TAG: ${{ needs.release.outputs.current_tag }} | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3.7.3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./.phpdoc/build |