[Task] Update docs #65
Workflow file for this run
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: "Documentation" | |
on: | |
pull_request_target: | |
branches: | |
- "[0-9]+.[0-9]+" | |
- "[0-9]+.x" | |
paths: | |
- 'doc/**' | |
- '.github/workflows/docs.yaml' | |
- 'README.md' | |
push: | |
branches: | |
- "[0-9]+.[0-9]+" | |
- "[0-9]+.x" | |
- "*_actions" | |
paths: | |
- 'doc/**' | |
- 'README.md' | |
permissions: | |
contents: read | |
jobs: | |
docs: | |
name: "Generate docs Pimcore Docs Generator" | |
runs-on: "ubuntu-latest" | |
steps: | |
- name: "Checkout code" | |
uses: "actions/checkout@v3" | |
with: | |
ref: ${{ github.event.pull_request.head.sha }} | |
- name: "Checkout Docs Generator" | |
uses: "actions/checkout@v3" | |
with: | |
repository: "pimcore/docs-generator" | |
ref: "main" | |
path: "./docs-generator" | |
token: ${{ secrets.DOCS_GENERATOR_ACCESS_TOKEN }} | |
- name: "Install Node" | |
uses: actions/setup-node@v3 | |
with: | |
node-version: 19.x | |
registry-url: 'https://registry.npmjs.org' | |
- name: Prepare Docs | |
working-directory: "./docs-generator" | |
run: | | |
mkdir docs | |
# copy docs to working directory | |
cp -r ../doc ./docs/ | |
# copy readme to working directory | |
cp -r ../README.md ./docs/ | |
# copy index page | |
cp bin/resources/00_index_empty.md ./docs/00_index.md | |
# use special docusaurus config (to exclude search plugin) and check for broken links | |
mv docusaurus.config.js.repos-tests docusaurus.config.js | |
- name: Build Docs | |
working-directory: "./docs-generator" | |
run: | | |
npm install | |
npm run build | |