1# SPDX-FileCopyrightText: Copyright 2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
2#
3# SPDX-License-Identifier: Apache-2.0
4#
5# Licensed under the Apache License, Version 2.0 (the License); you may
6# not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an AS IS BASIS, WITHOUT
13# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17name: Build documentation and pack
18on:
19  workflow_dispatch:
20  push:
21    branches:
22      - main
23  pull_request:
24    branches:
25      - main
26  release:
27    types: [published]
28jobs:
29  pack:
30    name: Generate pack
31    runs-on: ubuntu-20.04
32    steps:
33      - uses: actions/checkout@v3
34        with:
35          fetch-depth: 0
36
37      - name: Fetch tags
38        if: ${{ github.event_name == 'release' }}
39        run: |
40          git fetch --tags --force
41
42      - uses: Open-CMSIS-Pack/gen-pack-action@main
43        with:
44          doxygen-version: 1.9.2
45          packchk-version: 1.3.95
46          gen-doc-script: ./DoxyGen/gen_doc.sh
47          check-links-script: |
48            ./DoxyGen/check_links.sh \
49              ./Documentation/html/index.html \
50              ./DoxyGen
51          doc-path: ./Documentation/html
52          gen-pack-script: ./Scripts/gen_pack.sh
53          gen-pack-output: ./output
54          gh-pages-branch: gh-pages
55