From 55683078cc3fa0df9732765173eeef38f1326b1f Mon Sep 17 00:00:00 2001 From: Matthias Pohl Date: Tue, 13 Feb 2024 10:42:14 +0100 Subject: [PATCH] [FLINK-34045][ci] Adds CI for generating the docs on push events --- .github/workflows/ci.yml | 2 ++ .github/workflows/docs-ci.yml | 48 +++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 .github/workflows/docs-ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4c99011c7e7a6c..8cf8b568b8f7e9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,6 +20,8 @@ name: "Flink CI (beta)" on: push: + paths-ignore: + - 'docs/**' workflow_dispatch: permissions: read-all diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml new file mode 100644 index 00000000000000..934dad8a58fd7d --- /dev/null +++ b/.github/workflows/docs-ci.yml @@ -0,0 +1,48 @@ +# 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. + +# This workflow is meant for as a basic CI run covering the most-important features +# and default Java version. It is meant to run before a PullRequest is merged. + +name: "Flink Docs CI (beta)" + +on: + push: + paths: + - 'docs/**' + workflow_dispatch: + +permissions: read-all + +jobs: + docs-ci: + name: "Documentation Generation" + runs-on: ubuntu-22.04 + steps: + - name: "Flink Checkout" + uses: actions/checkout@v4 + with: + persist-credentials: false + fetch-depth: 0 + sparse-checkout: | + docs + - name: "Install Hugo" + shell: bash + run: | + ./docs/build_docs.sh install-hugo + - name: "Build docs" + shell: bash + run: | + ./docs/build_docs.sh build