1
0
mirror of https://github.com/FreeRTOS/FreeRTOS.git synced 2025-06-24 01:52:08 +08:00

Automate doxygen ZIP creation with GitHub Action ()

Automate creation of doxygen ZIP output by using the custom doxygen GitHub Action, that has been updated to generate ZIP artifact in PR
This commit is contained in:
Archit Aggarwal
2021-04-21 13:52:01 -07:00
committed by GitHub
parent 1e2f99a11b
commit fd9c1eb7a5
2 changed files with 39 additions and 1 deletions
.github/workflows
FreeRTOS-Plus/Source/Application-Protocols

@ -1,8 +1,10 @@
name: CI Checks name: CI Checks
on: on:
push: push:
pull_request: pull_request:
workflow_dispatch: workflow_dispatch:
jobs: jobs:
git-secrets: git-secrets:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -22,3 +24,39 @@ jobs:
run: | run: |
git-secrets --register-aws git-secrets --register-aws
git-secrets --scan git-secrets --scan
doxygen:
runs-on: ubuntu-20.04
steps:
- name: Clone repository
uses: actions/checkout@v2
with:
submodules: recursive
path: freertos
- name: Install Python3
uses: actions/setup-python@v2
with:
python-version: '3.8'
- name: Download tag dependency of coreMQTT-Agent
run: |
# We don't need to generate the coreMQTT docs, we only need the tag file.
# Therefore, we can just download it.
mkdir -p freertos/FreeRTOS-Plus/Source/Application-Protocols/coreMQTT-Agent/source/dependency/coreMQTT/docs/doxygen/output
wget -O freertos/FreeRTOS-Plus/Source/Application-Protocols/coreMQTT-Agent/source/dependency/coreMQTT/docs/doxygen/output/mqtt.tag \
"https://freertos.org/Documentation/api-ref/coreMQTT/docs/doxygen/output/mqtt.tag"
- name: Generate doxygen ZIP
uses: FreeRTOS/CI-CD-GitHub-Actions/doxygen@main
with:
path: ./freertos
# List of directories containing libraries whose doxygen output will be generated.
libs_parent_dir_path: FreeRTOS-Plus/Source,FreeRTOS-Plus/Source/AWS,FreeRTOS-Plus/Source/Application-Protocols
generate_zip: true
- name: Upload doxygen artifact if main branch
if: success() && github.ref == 'refs/heads/main'
env:
GIT_SHA:
uses: actions/upload-artifact@v2
with:
name: doxygen.zip-${{ github.sha }}
path: ./freertos/doxygen.zip
retention-days: 2