docs(changelog): prepare changelog for release #438
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: Doc-Generator | |
on: | |
push: | |
branches: [ master ] | |
pull_request: | |
branches: [ master ] | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Setup PHP8.1 | |
uses: shivammathur/setup-php@v2 | |
with: | |
php-version: '8.1' | |
- uses: actions/checkout@v2 | |
- name: Validate composer.json and composer.lock | |
run: composer validate --strict | |
- name: Cache Composer packages | |
id: composer-cache | |
uses: actions/cache@v2 | |
with: | |
path: vendor | |
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} | |
restore-keys: | | |
${{ runner.os }}-php- | |
- name: Install dependencies | |
if: steps.composer-cache.outputs.cache-hit != 'true' | |
run: composer install --prefer-dist --no-progress | |
- name: Composer dump-autoload to load all files | |
run: composer dump-autoload | |
- name: Generate Docs | |
run: composer run-script docs-generator | |
- name: Check if Docs are already generated | |
uses: tj-actions/verify-changed-files@v17 | |
id: verify-changed-files | |
with: | |
files: | | |
docs | |
- name: Run step only when files change. | |
if: steps.verify-changed-files.outputs.files_changed == 'true' | |
run: | | |
core.setFailed('Inconsistent Docs. Please run DocGenerator locally and commit generated Doc-Files. See docs/Docs.md for more information.') |