rnp/.github/workflows/man-pages.yml at main · rnpgp/rnp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# Copyright (c) 2026 [Ribose Inc](https://www.ribose.com).
# All rights reserved.
# This file is a part of rnp
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

name: man-pages

on:
  push:
    branches:
      - main
      - 'release/**'
    paths:
      - 'src/**/*.adoc'
      - 'cmake/Modules/AdocMan.cmake'
      - 'cmake/Modules/adoc-manpage.xsl'
      - 'ci/check-man-pages.sh'
      - '.github/workflows/man-pages.yml'
  pull_request:
    paths:
      - 'src/**/*.adoc'
      - 'cmake/Modules/AdocMan.cmake'
      - 'cmake/Modules/adoc-manpage.xsl'
      - 'ci/check-man-pages.sh'
      - '.github/workflows/man-pages.yml'

permissions:
  contents: read

jobs:
  dual-toolchain:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - name: Install toolchains
        run: |
          sudo apt-get update
          sudo apt-get -y install asciidoctor asciidoc docbook-xsl xsltproc man-db

      # Exercises both supported man page toolchains (asciidoctor and
      # asciidoc-py, #2395) and fails on warnings or render divergence.
      - name: Check man pages with both toolchains
        run: ./ci/check-man-pages.sh