Skip to content

Commit 71911b3

Browse files
committed
Docs workflow added.
1 parent f99ab9f commit 71911b3

File tree

4 files changed

+45
-2
lines changed

4 files changed

+45
-2
lines changed

.github/workflows/docs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: build
2+
3+
on:
4+
release:
5+
types: [ created ]
6+
workflow_dispatch:
7+
8+
jobs:
9+
test:
10+
name: Deploy docs
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Set up PHP
15+
uses: shivammathur/setup-php@v2
16+
with:
17+
php-version: '8.3'
18+
coverage: xdebug
19+
tools: composer:v2
20+
21+
- name: Checkout code
22+
uses: actions/checkout@v3
23+
with:
24+
fetch-depth: 0
25+
26+
- name: PHP Version Check
27+
run: php -v
28+
29+
- name: Validate Composer JSON
30+
run: composer validate
31+
32+
- name: Run Composer
33+
run: composer install --no-interaction
34+
35+
- name: Generate Docs
36+
run: |
37+
composer phpdoc
38+
39+
- name: Deploy
40+
uses: JamesIves/[email protected]
41+
with:
42+
branch: master
43+
folder: phpdoc

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/smoren/array-view)
33
[![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)
44
[![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)
5-
![Build and test](https://github.com/Smoren/array-view-php/actions/workflows/test_master.yml/badge.svg)
5+
![Build and test](https://github.com/Smoren/array-view-php/actions/workflows/test.yml/badge.svg)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

88
**Array View** is a PHP library that provides a powerful set of utilities for working with arrays in

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
"stan": ["./vendor/bin/phpstan analyse -l 9 src"],
6969
"phpdoc": [
7070
"export COMPOSER_PROCESS_TIMEOUT=9000",
71-
"vendor/bin/phpdoc -d ./src --visibility=public -v"
71+
"vendor/bin/phpdoc --directory ./src --visibility public --target ./phpdoc -v"
7272
]
7373
}
7474
}

0 commit comments

Comments
 (0)