mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-11-07 10:33:24 -08:00
0e9ba72924
Rename doc/ to docs/ so GitHub picks up docs/CONTRIBUTING.md and Doxygen keeps including it, and update all references to the old layout: - Doxygen output now goes to docs-output/, exposed by .gitignore - docs workflow triggers on docs/** and publishes docs-output/html - theme submodule moved to docs/doxygen/theme - schema URLs in both XML parsers point at docs/xsd/ - README, developer docs, desktop workflow filters, .dockerignore and gcovr config updated for the new paths The v3 card database schema is kept as docs/xsd/cards_v3.xsd.
79 lines
2.4 KiB
YAML
79 lines
2.4 KiB
YAML
name: Generate Docs
|
|
|
|
permissions:
|
|
contents: read # write permission to the destination repo come from 'deploy_key'
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- 'docs/**'
|
|
- '.github/workflows/documentation-build.yml'
|
|
- 'Doxyfile'
|
|
release:
|
|
types:
|
|
- published # publishing of stable releases and pre-releases
|
|
workflow_dispatch:
|
|
|
|
# Cancel earlier, unfinished runs of this workflow on the same branch (unless on release)
|
|
concurrency:
|
|
group: "${{ github.workflow }} @ ${{ github.ref_name }}"
|
|
cancel-in-progress: ${{ github.event_name != 'release' }}
|
|
|
|
env:
|
|
COCKATRICE_REF: ${{ github.ref_name }} # tag name if the commit is tagged, otherwise branch name
|
|
|
|
jobs:
|
|
docs:
|
|
name: Doxygen
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: "Checkout"
|
|
uses: actions/checkout@v7
|
|
with:
|
|
submodules: recursive
|
|
|
|
- name: "Install Graphviz"
|
|
shell: bash
|
|
run: |
|
|
sudo apt-get install -y graphviz
|
|
dot -V
|
|
|
|
- name: "Install Doxygen"
|
|
uses: ssciwr/doxygen-install@v2
|
|
with:
|
|
version: "1.18.0"
|
|
|
|
- name: "Update Doxygen Configuration"
|
|
shell: bash
|
|
run: |
|
|
git diff Doxyfile
|
|
doxygen -u Doxyfile
|
|
if git diff --quiet Doxyfile; then
|
|
echo "::notice::No config changes in Doxyfile detected."
|
|
else
|
|
echo "::error::Config changes in Doxyfile detected! Please update the file by running 'doxygen -u Doxyfile'."
|
|
echo ""
|
|
git diff --color=always Doxyfile
|
|
exit 1
|
|
fi
|
|
|
|
- name: "Generate Documentation"
|
|
if: always()
|
|
shell: bash
|
|
run: doxygen Doxyfile
|
|
|
|
- name: "Deploy to cockatrice.github.io/docs"
|
|
if: github.event_name == 'release' || github.event_name == 'workflow_dispatch'
|
|
uses: peaceiris/actions-gh-pages@v4
|
|
with:
|
|
deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
|
|
destination_dir: docs # docs will be available at https://cockatrice.github.io/docs/
|
|
external_repository: Cockatrice/cockatrice.github.io
|
|
publish_branch: master
|
|
publish_dir: ./docs-output/html
|
|
|
|
- name: Link to Documentation Page
|
|
if: github.event_name == 'release' || github.event_name == 'workflow_dispatch'
|
|
shell: bash
|
|
run: echo "::notice title=New documentation published::Shortly available at https://cockatrice.github.io/docs/"
|