camel-website/antora-playbook-snippets/antora-playbook.yml at main · apache/camel-website · 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
site:
  title: Apache Camel
  url: https://camel.apache.org
#  start_page: _@manual::index.adoc

content:
  sources:

    - url: https://github.com/apache/camel.git
      branches: main
      start_paths:
        # manual
        - docs/user-manual
        # main website for camel core
        - docs/main

    - url: https://github.com/apache/camel.git
      branches:
        - main
        - camel-4.22.x
        - camel-4.18.x
      start_paths:
        # eip
        - core/camel-core-engine/src/main/docs
        # main components doc
        - docs/components

# sub-projects
    - url: https://github.com/apache/camel-k.git
      # Let's keep latest active development + LTS active versions only
      branches:
        - main
        - release-2.11.x
        - release-2.10.x
      start_path: docs

    - url: https://github.com/apache/camel-kamelets.git
      branches:
        - main
        - 4.22.x
        - 4.18.x
      start_path: docs

    - url: https://github.com/apache/camel-quarkus.git
      branches:
        - main
        - 3.33.x
      start_path: docs

    - url: https://github.com/apache/camel-quarkus-examples.git
      branches: main
      start_path: docs

    - url: https://github.com/apache/camel-kafka-connector.git
      branches:
        - main
      start_paths:
        - docs
        - connectors

    - url: https://github.com/apache/camel-spring-boot.git
      branches:
        - main
        - camel-spring-boot-4.22.x
        - camel-spring-boot-4.18.x
      start_paths:
        - components-starter
        - core
        - docs/components
        - docs/spring-boot

    - url: https://github.com/apache/camel-karaf.git
      branches:
        - main
      start_path: docs

ui:
  bundle:
    url: ./antora-ui-camel/public/_

urls:
  redirect_facility: httpd
  latest_version_segment_strategy: redirect:from
  latest_version_segment: latest


output:
  dir: ./documentation

asciidoc:
  attributes:
    requires@: "'util=camel-website-util'"
#    uncomment sb-statistics to see more info on camel spring boot list page such as non-spring-boot components.
#    This also tests the output of unused camel-spring-boot json detection and fails the Antora build with errors.
#    sb-statistics: on
  extensions:
    - ./extensions/table.js
    - ./extensions/inline-styles.js
    - "@asciidoctor/tabs"

runtime:
  log:
    level: warn
    failure_level: warn
#    format: json

antora:
  extensions:
    # First, so it times the phases that follow. Antora suppresses its own
    # progress output whenever stdout is not a TTY, which is always the case
    # under `yarn build-all` and on CI.
    - ./extensions/build-progress.js

    - ./extensions/promote-deprecated-attribute.js

    # Registers the [asciinema] block and injects the player assets plus the asciinema-styles,
    # asciinema-load-scripts and asciinema-create-scripts partials into the UI catalog. The UI
    # references those partials from head-styles.hbs and footer-scripts.hbs, guarded on the
    # page-asciinemacasts attribute this extension sets.
    - require: '@springio/antora-extensions/asciinema-extension'

    - require: '@djencks/antora-aggregate-collector'
#      log_level: trace
      componentversions:
        - name: components
          version: '*'
          local-mappings: ac-mappings.yml
        - name: camel-spring-boot
          version: '*'
          local-mappings: ac-mappings.yml
        - name: camel-kafka-connector
          version: '*'
          local-mappings: ac-mappings.yml

    # NOTE these two are required via local wrappers rather than directly; see
    # extensions/asciidoctor-jsonpath.js for why (Antora 3.1.9+ register-signature warning
    # combined with runtime.log.failure_level: warn).
    - require: ./extensions/asciidoctor-jsonpath.js
#      log_level: trace

    - require: ./extensions/asciidoctor-antora-indexer.js
#      log_level: debug
      requires: 'util=camel-website-util'
      index_pages:
        - local:
            component: camel-kafka-connector
            path: indexPages.yml
        - local:
            component: camel-kamelets
            path: indexPages.yml

    # Reports unreferenced images to build/unused-media.txt. Logs at info rather than warn on
    # purpose: this playbook sets runtime.log.failure_level to warn, so warning once per unused
    # file would fail the site build over a housekeeping issue. That is why the off-the-shelf
    # @bonitasoft/antora-detect-unused-media-extension was dropped in favour of this one.
    - ./extensions/detect-unused-media.js