Skip to content

Reconciled notification variables in scripts. #2136

Reconciled notification variables in scripts.

Reconciled notification variables in scripts. #2136

# This action is used for Vortex maintenance. It will not be used in the scaffolded project.
name: Vortex - Test docs
on:
push:
tags:
- '**'
branches:
- '**'
jobs:
vortex-test-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
with:
node-version: 22.17.1
- name: Setup PHP
uses: shivammathur/setup-php@bf6b4fbd49ca58e4608c9c89fba0b8d90bd2a39f # v2
with:
php-version: 8.3
- name: Check docs up-to-date
run: |
composer --working-dir=.utils install
yarn run update-variables
git diff --quiet HEAD || { echo "Docs not up-to-date. Run 'cd .vortex && ahoy update-docs' and commit changes."; git diff; exit 1; }
working-directory: '${{ github.workspace }}/.vortex/docs'
- name: Install dependencies
run: yarn install --frozen-lockfile
working-directory: '${{ github.workspace }}/.vortex/docs'
- name: Lint code
run: yarn run lint
working-directory: '${{ github.workspace }}/.vortex/docs'
- name: Run tests
run: yarn run test:coverage
working-directory: '${{ github.workspace }}/.vortex/docs'
- name: Check spelling
run: yarn run spellcheck
working-directory: '${{ github.workspace }}/.vortex/docs'
- name: Build documentation site
run: yarn run build
working-directory: '${{ github.workspace }}/.vortex/docs'
- name: Deploy to Netlify
uses: nwtgck/actions-netlify@4cbaf4c08f1a7bfa537d6113472ef4424e4eb654 # v3.0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
publish-dir: '.vortex/docs/build'
production-branch: develop
deploy-message: "Deploy from GitHub Actions"
enable-pull-request-comment: true
enable-commit-comment: true
overwrites-pull-request-comment: true
env:
NETLIFY_SITE_ID: ${{ secrets.DOCS_NETLIFY_SITE_ID }}
NETLIFY_AUTH_TOKEN: ${{ secrets.DOCS_NETLIFY_AUTH_TOKEN }}
timeout-minutes: 1
- name: Upload coverage reports as an artifact
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5
with:
name: ${{github.job}}-docs-coverage-report
path: .vortex/docs/.logs
include-hidden-files: true
if-no-files-found: error
- name: Upload coverage report to Codecov
uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5
with:
files: .vortex/docs/.logs/cobertura.xml
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}