Skip to content

Commit f3e3631

Browse files
committed
Add docs worflow
1 parent b3c6868 commit f3e3631

1 file changed

Lines changed: 64 additions & 0 deletions

File tree

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: "Documentation"
2+
3+
on: # yamllint disable-line rule:truthy
4+
workflow_call:
5+
inputs:
6+
deploy:
7+
description: "Whether to include upcoming releases in the auto-detection"
8+
default: false
9+
required: false
10+
type: "boolean"
11+
12+
jobs:
13+
documentation:
14+
name: "Documentation"
15+
runs-on: "ubuntu-latest"
16+
steps:
17+
- name: "Checkout"
18+
uses: "actions/checkout@v6"
19+
20+
- name: "Build"
21+
uses: "phpDocumentor/phpDocumentor@master"
22+
23+
- name: "Deploy"
24+
if: "${{ inputs.deploy }}"
25+
uses: "actions/upload-artifact@v6"
26+
with:
27+
name: "documentation"
28+
path: "build/docs"
29+
retention-days: 1
30+
31+
deploy:
32+
name: "Deploy"
33+
if: "${{ inputs.deploy }}"
34+
runs-on: "ubuntu-latest"
35+
needs: "documentation"
36+
steps:
37+
- name: "Checkout"
38+
uses: "actions/checkout@v6"
39+
with:
40+
repository: "phpDocumentor/docs"
41+
token: "${{ secrets.BOT_TOKEN }}"
42+
path: "docs"
43+
44+
- name: "Download"
45+
uses: "actions/download-artifact@v7"
46+
with:
47+
name: "documentation"
48+
path: "build/docs"
49+
50+
- name: "Copy files"
51+
run: "rsync -r --delete build/docs/* docs/docs/components/${{ inputs.component }}"
52+
53+
- name: "Commit"
54+
uses: "stefanzweifel/git-auto-commit-action@v7"
55+
with:
56+
repository: "docs"
57+
commit_message: "Update ${{ inputs.component }} documentation"
58+
59+
- name: "Push"
60+
uses: "ad-m/github-push-action@master"
61+
with:
62+
directory: "docs"
63+
github_token: "${{ secrets.BOT_TOKEN }}"
64+
repository: "phpDocumentor/docs"

0 commit comments

Comments
 (0)