Skip to content

Commit

Permalink
Automatically test the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed Jul 6, 2023
1 parent 7197718 commit 37f12ea
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: "Documentation"

on:
pull_request:
branches:
- "*.*"
- "main"
paths:
- .github/workflows/documentation.yml
- docs/**
push:
branches:
- "*.*"
- "main"
paths:
- .github/workflows/documentation.yml
- docs/**

jobs:
validate-with-guides:
name: "Validate documentation with phpDocumentor/guides"
runs-on: "ubuntu-22.04"

steps:
- name: "Checkout code"
uses: "actions/checkout@v3"

- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
coverage: "none"
php-version: "8.2"

- name: "Remove existing composer file"
run: "rm composer.json"

- name: "Require phpdocumentor/guides-cli"
run: "composer require --dev phpdocumentor/guides-cli dev-main@dev --no-update"

- name: "Configure minimum stability"
run: "composer config minimum-stability dev"

- name: "Install dependencies with Composer"
uses: "ramsey/composer-install@v2"
with:
dependency-versions: "highest"

- name: "Run guides-cli"
run: "vendor/bin/guides -vvv --no-progress --fail-on-log Documentation /tmp/test "

0 comments on commit 37f12ea

Please sign in to comment.