Vivien Nicolas | fbbf127 | 2020-10-02 20:08:13 +0200 | [diff] [blame] | 1 | # Copyright (c) 2020 Project CHIP Authors |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | # you may not use this file except in compliance with the License. |
| 5 | # You may obtain a copy of the License at |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | # See the License for the specific language governing permissions and |
| 13 | # limitations under the License. |
| 14 | |
| 15 | name: Doxygen |
| 16 | |
| 17 | on: |
Michael Spang | 7ef91f9 | 2021-04-12 02:32:59 -0400 | [diff] [blame] | 18 | push: |
Victor Morales | 92f8343 | 2022-01-27 15:00:29 -0800 | [diff] [blame] | 19 | paths: |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 20 | - "**.do[xc]" |
| 21 | - "**.c[cs]?" |
| 22 | - "**.cxx" |
| 23 | - "**.cpp" |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 24 | - "**.c\\+\\+" |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 25 | - "**.ii" |
| 26 | - "**.ixx" |
| 27 | - "**.ipp" |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 28 | - "**.i\\+\\+" |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 29 | - "**.inl" |
| 30 | - "**.[hH]" |
| 31 | - "**.hh" |
| 32 | - "**.HH" |
| 33 | - "**.hxx" |
| 34 | - "**.hpp" |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 35 | - "**.h\\+\\+" |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 36 | - "**.mm" |
| 37 | - "**.txt" |
| 38 | - "**.[ido]dl" |
| 39 | - "**.java" |
| 40 | - "**.d" |
| 41 | - "**.php[45]?" |
| 42 | - "**.inc" |
| 43 | - "**.phtml" |
| 44 | - "**.[mM]" |
Michael Spang | 7ef91f9 | 2021-04-12 02:32:59 -0400 | [diff] [blame] | 45 | pull_request: |
Victor Morales | 92f8343 | 2022-01-27 15:00:29 -0800 | [diff] [blame] | 46 | paths: |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 47 | - "**.do[xc]" |
| 48 | - "**.c[cs]?" |
| 49 | - "**.cxx" |
| 50 | - "**.cpp" |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 51 | - "**.c\\+\\+" |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 52 | - "**.ii" |
| 53 | - "**.ixx" |
| 54 | - "**.ipp" |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 55 | - "**.i\\+\\+" |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 56 | - "**.inl" |
| 57 | - "**.[hH]" |
| 58 | - "**.hh" |
| 59 | - "**.HH" |
| 60 | - "**.hxx" |
| 61 | - "**.hpp" |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 62 | - "**.h\\+\\+" |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 63 | - "**.mm" |
| 64 | - "**.txt" |
| 65 | - "**.[ido]dl" |
| 66 | - "**.java" |
| 67 | - "**.d" |
| 68 | - "**.php[45]?" |
| 69 | - "**.inc" |
| 70 | - "**.phtml" |
| 71 | - "**.[mM]" |
Damian Królik | bfc7254 | 2021-06-01 19:55:22 +0200 | [diff] [blame] | 72 | workflow_dispatch: |
Vivien Nicolas | fbbf127 | 2020-10-02 20:08:13 +0200 | [diff] [blame] | 73 | |
Justin Wood | bf8b16b | 2021-06-15 20:36:09 -0700 | [diff] [blame] | 74 | concurrency: |
Justin Wood | ed637ad | 2021-07-03 07:39:13 -0700 | [diff] [blame] | 75 | group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} |
Justin Wood | bf8b16b | 2021-06-15 20:36:09 -0700 | [diff] [blame] | 76 | cancel-in-progress: true |
Justin Wood | 4f47a33 | 2022-03-04 15:54:19 -0800 | [diff] [blame] | 77 | |
Vivien Nicolas | fbbf127 | 2020-10-02 20:08:13 +0200 | [diff] [blame] | 78 | jobs: |
Justin Wood | fff0cc5 | 2021-03-10 18:39:35 -0800 | [diff] [blame] | 79 | doxygen: |
Justin Wood | 73f3d5b | 2021-03-10 13:11:28 -0800 | [diff] [blame] | 80 | name: Build Doxygen |
Justin Wood | 9efd5c0 | 2021-06-02 19:03:02 -0700 | [diff] [blame] | 81 | |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 82 | runs-on: ubuntu-latest |
Victor Morales | f7f1cc3 | 2021-11-30 08:31:47 -0800 | [diff] [blame] | 83 | container: |
Justin Wood | f0adeef | 2023-07-14 11:51:49 -0700 | [diff] [blame] | 84 | image: ghcr.io/project-chip/chip-build-doxygen:1 |
Victor Morales | f7f1cc3 | 2021-11-30 08:31:47 -0800 | [diff] [blame] | 85 | |
Justin Wood | 469e8eb | 2021-03-24 12:06:43 -0700 | [diff] [blame] | 86 | if: github.actor != 'restyled-io[bot]' |
Vivien Nicolas | fbbf127 | 2020-10-02 20:08:13 +0200 | [diff] [blame] | 87 | |
| 88 | steps: |
Justin Wood | 86511a1 | 2021-11-08 12:07:01 -0800 | [diff] [blame] | 89 | - name: "Print Actor" |
| 90 | run: echo ${{github.actor}} |
Arkadiusz Bokowy | 4895dc6 | 2023-02-11 01:15:55 +0100 | [diff] [blame] | 91 | - name: Checkout |
dependabot[bot] | 4f87971 | 2023-07-11 17:30:32 +0000 | [diff] [blame] | 92 | uses: actions/checkout@v3 |
Vivien Nicolas | fbbf127 | 2020-10-02 20:08:13 +0200 | [diff] [blame] | 93 | - name: Generate |
| 94 | run: scripts/helpers/doxygen.sh |
Justin Wood | 73f3d5b | 2021-03-10 13:11:28 -0800 | [diff] [blame] | 95 | - name: Extract branch name |
| 96 | shell: bash |
| 97 | run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF##*/})" |
| 98 | id: extract_branch |
| 99 | - name: Deploy if master |
Damian Królik | 499fa46 | 2021-06-08 22:09:14 +0200 | [diff] [blame] | 100 | if: steps.extract_branch.outputs.branch == 'master' && github.repository == 'project-chip/connectedhomeip' |
Justin Wood | 9d87afe | 2021-03-10 05:58:07 -0800 | [diff] [blame] | 101 | uses: peaceiris/actions-gh-pages@v3 |
| 102 | with: |
Damian Królik | bfc7254 | 2021-06-01 19:55:22 +0200 | [diff] [blame] | 103 | deploy_key: ${{ secrets.DOXYGEN_DEPLOY_KEY }} |
| 104 | external_repository: project-chip/connectedhomeip-doc |
Justin Wood | 9d87afe | 2021-03-10 05:58:07 -0800 | [diff] [blame] | 105 | publish_dir: ./docs/html |
Damian Królik | bfc7254 | 2021-06-01 19:55:22 +0200 | [diff] [blame] | 106 | # Keep only the latest version of the documentation |
| 107 | force_orphan: true |