Skip to content

Commit

Permalink
Docs workflow added.
Browse files Browse the repository at this point in the history
  • Loading branch information
Smoren committed Mar 13, 2024
1 parent f99ab9f commit 71911b3
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 2 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: build

on:
release:
types: [ created ]
workflow_dispatch:

jobs:
test:
name: Deploy docs
runs-on: ubuntu-latest

steps:
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
coverage: xdebug
tools: composer:v2

- name: Checkout code
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: PHP Version Check
run: php -v

- name: Validate Composer JSON
run: composer validate

- name: Run Composer
run: composer install --no-interaction

- name: Generate Docs
run: |
composer phpdoc
- name: Deploy
uses: JamesIves/github-pages-deploy-action@4.1.0
with:
branch: master
folder: phpdoc
File renamed without changes.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/smoren/array-view)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Smoren/array-view-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Smoren/array-view-php/?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/Smoren/array-view-php/badge.svg?branch=master)](https://coveralls.io/github/Smoren/array-view-php?branch=master)
![Build and test](https://github.com/Smoren/array-view-php/actions/workflows/test_master.yml/badge.svg)
![Build and test](https://github.com/Smoren/array-view-php/actions/workflows/test.yml/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**Array View** is a PHP library that provides a powerful set of utilities for working with arrays in
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"stan": ["./vendor/bin/phpstan analyse -l 9 src"],
"phpdoc": [
"export COMPOSER_PROCESS_TIMEOUT=9000",
"vendor/bin/phpdoc -d ./src --visibility=public -v"
"vendor/bin/phpdoc --directory ./src --visibility public --target ./phpdoc -v"
]
}
}

0 comments on commit 71911b3

Please sign in to comment.