mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-02-15 01:39:17 +08:00
f76b97e0c1
* [doc] doxygen attach github pages * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml
74 lines
1.9 KiB
YAML
74 lines
1.9 KiB
YAML
name: doc_doxygen
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- master
|
|
paths:
|
|
- 'documentation/doxygen/**'
|
|
- 'src/**'
|
|
- 'include/**'
|
|
- 'components/drivers/include/drivers/**'
|
|
- 'components/dfs/dfs_v2/include/**'
|
|
- 'components/dfs/dfs_v2/src/**'
|
|
- 'components/finsh/**'
|
|
- '.github/workflows/doxygen.yml'
|
|
# Runs at 16:00 UTC (BeiJing 00:00) on the 30st of every month
|
|
push:
|
|
branches: [master]
|
|
paths:
|
|
- 'documentation/doxygen/**'
|
|
- 'src/**'
|
|
- 'include/**'
|
|
- 'components/drivers/include/drivers/**'
|
|
- 'components/dfs/dfs_v2/include/**'
|
|
- 'components/dfs/dfs_v2/src/**'
|
|
- 'components/finsh/**'
|
|
- '.github/workflows/doxygen.yml'
|
|
schedule:
|
|
- cron: '0 16 30 * *'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-22.04
|
|
name: doxygen_doc generate
|
|
if: github.repository_owner == 'RT-Thread'
|
|
steps:
|
|
- uses: actions/checkout@main
|
|
with:
|
|
submodules: 'recursive'
|
|
- name: Install Tools
|
|
shell: bash
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get -qq install doxygen graphviz
|
|
- name: generate doxygen html
|
|
shell: bash
|
|
run: |
|
|
cd documentation/doxygen
|
|
doxygen Doxyfile
|
|
cat Doxyfile
|
|
|
|
- name: Upload static files as artifact
|
|
id: deployment
|
|
uses: actions/upload-pages-artifact@main # or specific "vX.X.X" version tag for this action
|
|
with:
|
|
path: documentation/doxygen/html/
|
|
|
|
deploy:
|
|
if: github.event_name == 'push'
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-22.04
|
|
needs: build
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@main
|