This is an automated email from the ASF dual-hosted git repository.
gansheer pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k.git
The following commit(s) were added to refs/heads/main by this push:
new dc4b69f85 ci: doc validation workflow
dc4b69f85 is described below
commit dc4b69f857dc2be07a79b4aaf3d5e3eba9290a17
Author: Gaelle Fournier <[email protected]>
AuthorDate: Tue Oct 28 09:21:34 2025 +0100
ci: doc validation workflow
---
.github/workflows/pr-doc-validation.yaml | 84 ++++++++++++++++++++++++++++++++
1 file changed, 84 insertions(+)
diff --git a/.github/workflows/pr-doc-validation.yaml
b/.github/workflows/pr-doc-validation.yaml
new file mode 100644
index 000000000..4e41511ba
--- /dev/null
+++ b/.github/workflows/pr-doc-validation.yaml
@@ -0,0 +1,84 @@
+--- #
---------------------------------------------------------------------------
+
+# ---------------------------------------------------------------------------
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ---------------------------------------------------------------------------
+
+
+name: PR doc validation
+on:
+ pull_request:
+ branches:
+ - main
+ - "release-*"
+ paths:
+ - '**.adoc'
+ - 'pkg/apis/**'
+ - '!**/README.adoc'
+
+concurrency:
+ group: ${{ github.ref }}-${{ github.workflow }}
+ cancel-in-progress: true
+
+permissions:
+ contents: read
+
+jobs:
+ check-doc:
+ if: github.repository == 'apache/camel-k'
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout camel-k repo
+ uses: actions/checkout@v4
+ with:
+ persist-credentials: false
+ submodules: recursive
+ path: camel-k
+ - name: Checkout camel-website repo
+ uses: actions/checkout@v4
+ with:
+ repository: apache/camel-website
+ path: camel-website
+ ref: main
+
+ - id: setup-jdk
+ name: Set up JDK
+ uses: actions/setup-java@v4
+ with:
+ java-version: '17'
+ distribution: 'temurin'
+ - id: setup-go
+ name: Set up Go
+ uses: actions/setup-go@v5
+ with:
+ go-version-file: 'camel-k/go.mod'
+ check-latest: true
+
+ # Autogenerated resources
+ - name: Run project refresh actions
+ shell: bash
+ run: |
+ cd camel-k
+ make generate codegen update-docs
+
+ - name: Validate documentation
+ shell: bash
+ run: |
+ cd camel-website
+ yarn install
+ cd ../camel-k/docs
+ yarn install
+ ./local-build.sh quick
\ No newline at end of file
