mirror of
https://github.com/FreeRTOS/FreeRTOS.git
synced 2026-08-11 07:34:39 +00:00
fd9c1eb7a5
Automate creation of doxygen ZIP output by using the custom doxygen GitHub Action, that has been updated to generate ZIP artifact in PR
63 lines
2.1 KiB
YAML
63 lines
2.1 KiB
YAML
name: CI Checks
|
|
|
|
on:
|
|
push:
|
|
pull_request:
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
git-secrets:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
with:
|
|
submodules: recursive
|
|
- name: Checkout awslabs/git-secrets
|
|
uses: actions/checkout@v2
|
|
with:
|
|
repository: awslabs/git-secrets
|
|
ref: master
|
|
path: git-secrets
|
|
- name: Install git-secrets
|
|
run: cd git-secrets && sudo make install && cd ..
|
|
- name: Run git-secrets
|
|
run: |
|
|
git-secrets --register-aws
|
|
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
|
|
|