Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate API docs #4449

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
wip
  • Loading branch information
jbrooksuk committed Jan 3, 2025
commit 0f41cecfd8fba86d496e97760680fc464a4940ae
25 changes: 25 additions & 0 deletions .github/workflows/build-api-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
on:
schedule:
- cron: '0 7 * * *'

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'

- name: Install dependencies
run: composer install

- name: Build API docs
run: php vendor/bin/phpdoc -d src -t docs/api

- name: Commit and push changes
run: |
git config --local user.email "
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -19,4 +19,6 @@ npm-debug.log
yarn-error.log
/.fleet
/.idea
/.scribe
/.vscode
/public/docs
7 changes: 4 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
@@ -10,20 +10,21 @@
],
"repositories": {
"cachet-core": {
"type": "vcs",
"url": "git@github.com:cachethq/core.git"
"type": "path",
"url": "../cachet-core"
}
},
"require": {
"php": "^8.2",
"cachethq/core": "dev-main",
"cachethq/core": "*",
"guzzlehttp/guzzle": "^7.2",
"laravel/framework": "^11.2",
"laravel/sanctum": "^4.0",
"laravel/tinker": "^2.9"
},
"require-dev": {
"fakerphp/faker": "^1.23",
"knuckleswtf/scribe": "^4.38",
"laravel/pail": "^1.1",
"laravel/pint": "^1.13",
"laravel/sail": "^1.26",
Loading