mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2025-12-12 04:34:43 +04:00
ee36c66572
* fbt: doxygen target * github: adjustments for doxygen * github: always generate docs, only upload for dev * doxygen: fixed exclusion path for awesome-css * github: stricter check for push ref * github: bumped action version to fix node.js deprecation * github: added PVS report url to workflow summary * github: pvs: reworked report URL handling * github: added size report to summary * docs: added `doxygen` target * fbt: common naming scheme for COMSTR * Documentation: fix warnings and errors * Doxygen: stricter warning checks * fbt: "doxy" target, opens generated doxygen documentation in browser * github: doxygen: now using edge (1.10) version Co-authored-by: あく <alleteam@gmail.com>
63 lines
1.9 KiB
YAML
63 lines
1.9 KiB
YAML
name: 'Generate documentation with Doxygen'
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- dev
|
|
pull_request:
|
|
|
|
env:
|
|
TARGETS: f7
|
|
DEFAULT_TARGET: f7
|
|
|
|
jobs:
|
|
doxygen:
|
|
if: ${{ !github.event.pull_request.head.repo.fork }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: 'Wipe workspace'
|
|
run: find ./ -mount -maxdepth 1 -exec rm -rf {} \;
|
|
|
|
- name: 'Checkout code'
|
|
uses: actions/checkout@v4
|
|
with:
|
|
submodules: true
|
|
fetch-depth: 1
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
|
|
- name: 'Get commit details'
|
|
id: names
|
|
run: |
|
|
if [[ ${{ github.event_name }} == 'pull_request' ]]; then
|
|
TYPE="pull"
|
|
elif [[ "${{ github.ref }}" == "refs/tags/"* ]]; then
|
|
TYPE="tag"
|
|
else
|
|
TYPE="other"
|
|
fi
|
|
python3 scripts/get_env.py "--event_file=${{ github.event_path }}" "--type=$TYPE"
|
|
|
|
- name: 'Generate documentation'
|
|
uses: mattnotmitt/doxygen-action@edge
|
|
env:
|
|
DOXY_SRC_ROOT: "${{ github.workspace }}"
|
|
DOXY_CONFIG_DIR: "${{ github.workspace }}/documentation/doxygen"
|
|
DOXY_OUTPUT_DIR: "${{ github.workspace }}/documentation/doxygen/build"
|
|
with:
|
|
working-directory: 'documentation/'
|
|
doxyfile-path: './doxygen/Doxyfile-awesome.cfg'
|
|
|
|
- name: 'Upload documentation'
|
|
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/dev' }}
|
|
uses: jakejarvis/s3-sync-action@v0.5.1
|
|
env:
|
|
AWS_S3_BUCKET: "${{ secrets.FW_DOCS_AWS_BUCKET }}"
|
|
AWS_ACCESS_KEY_ID: "${{ secrets.FW_DOCS_AWS_ACCESS_KEY }}"
|
|
AWS_SECRET_ACCESS_KEY: "${{ secrets.FW_DOCS_AWS_SECRET_KEY }}"
|
|
AWS_REGION: "${{ secrets.FW_DOCS_AWS_REGION }}"
|
|
SOURCE_DIR: "./documentation/doxygen/build/html"
|
|
DEST_DIR: "${{steps.names.outputs.branch_name}}"
|
|
with:
|
|
args: "--delete"
|
|
|