From eb78154353add5c3db0da237827454a888cef88d Mon Sep 17 00:00:00 2001 From: Archit Aggarwal Date: Wed, 21 Apr 2021 13:52:01 -0700 Subject: [PATCH] Automate doxygen ZIP creation with GitHub Action (#568) Automate creation of doxygen ZIP output by using the custom doxygen GitHub Action, that has been updated to generate ZIP artifact in PR --- .github/workflows/ci.yml | 62 +++++++++++++++++++ .../Application-Protocols/coreMQTT-Agent | 2 +- 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000000..8912224fa9 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,62 @@ +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 + diff --git a/FreeRTOS-Plus/Source/Application-Protocols/coreMQTT-Agent b/FreeRTOS-Plus/Source/Application-Protocols/coreMQTT-Agent index d61dd0921b..134b478a48 160000 --- a/FreeRTOS-Plus/Source/Application-Protocols/coreMQTT-Agent +++ b/FreeRTOS-Plus/Source/Application-Protocols/coreMQTT-Agent @@ -1 +1 @@ -Subproject commit d61dd0921bd651c0bfbaa2e41bb0eda56245a36b +Subproject commit 134b478a4862aa084575e3c37ab9fc86c04d3509