[FEATURE] Create a rst theme to render markdown #561
Workflow file for this run
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: "Documentation" | |
| on: # yamllint disable-line rule:truthy | |
| pull_request: | |
| branches: | |
| - "main" | |
| paths: | |
| - ".github/workflows/documentation.yml" | |
| - "docs/**" | |
| - "packages/**" | |
| push: | |
| branches: | |
| - "main" | |
| paths: | |
| - ".github/workflows/documentation.yml" | |
| - "docs/**" | |
| - "packages/**" | |
| jobs: | |
| validate-with-guides: | |
| name: "Validate documentation with phpDocumentor/guides" | |
| runs-on: "ubuntu-22.04" | |
| steps: | |
| - name: "Checkout code" | |
| uses: "actions/checkout@v4" | |
| - name: "Install PHP" | |
| uses: "shivammathur/setup-php@v2" | |
| with: | |
| coverage: "none" | |
| php-version: "8.2" | |
| - name: "Set COMPOSER_ROOT_VERSION" | |
| run: | | |
| echo "COMPOSER_ROOT_VERSION=1.x-dev" >> $GITHUB_ENV | |
| - name: "Install dependencies with Composer" | |
| uses: "ramsey/composer-install@v3" | |
| with: | |
| dependency-versions: "highest" | |
| - name: "Run guides-cli" | |
| run: "vendor/bin/guides -vvv --no-progress docs --output='/tmp/test' --fail-on-log" | |
| build: | |
| name: "Documentation" | |
| if: "${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Checkout" | |
| uses: "actions/checkout@v4" | |
| - name: "Build" | |
| uses: "phpDocumentor/phpDocumentor@master" | |
| - name: "Upload" | |
| uses: "actions/upload-artifact@v4" | |
| with: | |
| name: "documentation" | |
| path: "build/docs" | |
| retention-days: 1 | |
| deploy: | |
| name: "Deploy" | |
| if: "${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}" | |
| runs-on: "ubuntu-latest" | |
| needs: "build" | |
| steps: | |
| - name: "Checkout" | |
| uses: "actions/checkout@v4" | |
| with: | |
| repository: "phpDocumentor/docs" | |
| token: "${{ secrets.BOT_TOKEN }}" | |
| path: "docs" | |
| - name: "Download" | |
| uses: "actions/download-artifact@v4" | |
| with: | |
| name: "documentation" | |
| path: "build/docs" | |
| - name: "Copy files" | |
| run: "rsync -r --delete build/docs/* docs/docs/components/guides" | |
| - name: "Commit" | |
| uses: "stefanzweifel/git-auto-commit-action@v5" | |
| with: | |
| repository: "docs" | |
| commit_message: "Update guides documentation" | |
| - name: "Push" | |
| uses: "ad-m/github-push-action@master" | |
| with: | |
| directory: "docs" | |
| github_token: "${{ secrets.BOT_TOKEN }}" | |
| repository: "phpDocumentor/docs" |