You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "oscerd (via GitHub)" <gi...@apache.org> on 2026/08/26 05:24:35 UTC

[PR] ci: scope the local docs build to components 4.22.x so PR doc validation resolves xrefs [camel]

oscerd opened a new pull request, #25748:
URL: https://github.com/apache/camel/pull/25748

   ## Problem
   
   `PR doc validation` fails on **every** PR targeting `camel-4.22.x`, with 433 asciidoctor errors, all of the same shape:
   
   ```
   ERROR (asciidoctor): target of xref not found: components::index.adoc
   ERROR (asciidoctor): target of xref not found: components:languages:simple-language.adoc
   ERROR (asciidoctor): target of xref not found: next@components:eips:ai-patterns.adoc
   ```
   
   They land in files such as `core/camel-core-engine/src/main/docs/modules/eips/pages/*.adoc` — files the failing PRs never touch. Confirmed on two unrelated PRs:
   
   - #25733 (camel-docling backport)
   - #25588 (camel-spring-redis backport, which touches no core EIP docs at all)
   
   A main-based run of the same job reports **0** asciidoctor errors, so this is branch-level, not PR content.
   
   ## Cause
   
   The job runs camel-website's `antora-local-build.sh` in `quick` mode. Quick mode builds the local checkout and resolves everything else from the published `site-manifest.json`. Which components are taken from local sources is decided by the `components:` filter in `docs/source-watch.yml`.
   
   On `main` that filter is active:
   
   ```yaml
         components:
           - name: components
             version: next
   ```
   
   On this branch it was left commented out, so `components:` is an empty key. With no filter the local build isn't scoped, Antora tries to resolve the whole `components` namespace out of the local checkout, and every xref into it fails.
   
   The `next@components:...` error is the same cause seen from the other side: with the filter empty there is no correctly-scoped components source at all.
   
   ## Fix
   
   Uncomment the filter using this branch's own version:
   
   ```yaml
         components:
           - name: components
             version: 4.22.x
   ```
   
   `4.22.x` matches what both `docs/components/antora.yml` and `core/camel-core-engine/src/main/docs/antora.yml` already declare on this branch. Components other than the local one then come from the site manifest, exactly as on `main`.
   
   ## Verification
   
   This PR **is** the verification. I could not reproduce the Antora build locally (camel-website has no toolchain installed here, and installing it hits the same native-dependency problem that intermittently breaks this job), so the doc-validation job on this PR is the test: it should go from 433 errors to clean.
   
   If it does not, the change should be dropped rather than iterated on blindly.
   
   ## Note
   
   `camel-4.18.x` and `camel-4.4.x` carry the same commented-out filter, so the same failure is latent there. Nothing currently triggers doc validation on those branches; worth a follow-up if that changes.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] ci: scope the local docs build to components 4.22.x so PR doc validation resolves xrefs [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #25748:
URL: https://github.com/apache/camel/pull/25748#issuecomment-5421114450

   <!-- ci-tested-modules -->
   :test_tube: **CI tested the following changed modules:**
   
   - `docs`
   
   ---
   
   <details><summary>:microscope: Scalpel shadow comparison — Scalpel: 1 tested, 0 compile-only — current: 0 all tested</summary>
   
   [Maveniverse Scalpel](https://github.com/maveniverse/scalpel) detected **1 affected modules** (current approach: 0).
   
   <details><summary>:warning: Modules only in Scalpel (1)</summary>
   
   - `docs`
   
   </details>
   
   **Skip-tests mode would test 1 modules** (1 direct + 0 downstream), **skip tests for 0** (generated code, meta-modules)
   
   <details><summary>Modules Scalpel would test (1)</summary>
   
   - `docs`
   
   </details>
   
   > :information_source: Shadow mode — Scalpel observes but does not affect test execution. [Learn more](https://github.com/maveniverse/scalpel)
   
   </details>
   
   ---
   :gear: [View full build and test results](https://github.com/apache/camel/actions/runs/32933927143)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] ci: scope the local docs build to components 4.22.x so PR doc validation resolves xrefs [camel]

Posted by "oscerd (via GitHub)" <gi...@apache.org>.
oscerd merged PR #25748:
URL: https://github.com/apache/camel/pull/25748


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] ci: scope the local docs build to components 4.22.x so PR doc validation resolves xrefs [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #25748:
URL: https://github.com/apache/camel/pull/25748#issuecomment-5420994023

   :star2: Thank you for your contribution to the Apache Camel project! :star2:
     :robot: CI automation will test this PR automatically.
   
     :camel: Apache Camel Committers, please review the following items:
   
     * First-time contributors **require MANUAL approval** for the GitHub Actions to run
     * You can use the command `/component-test (camel-)component-name1 (camel-)component-name2..` to request a test from the test bot although they are normally detected and executed by CI.
     * You can label PRs using `skip-tests` and `test-dependents` to fine-tune the checks executed by this PR.
     * Build and test logs are available in the summary page. **Only** [Apache Camel committers](https://camel.apache.org/community/team/#committers) have access to the summary.
     
     :warning: Be careful when sharing logs. Review their contents before sharing them publicly.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org