Skip to content

Commit

Permalink
[FLINK-34045][ci] Adds CI for generating the docs on push events
Browse files Browse the repository at this point in the history
  • Loading branch information
XComp committed Feb 16, 2024
1 parent 26e9f4c commit 5568307
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ name: "Flink CI (beta)"

on:
push:
paths-ignore:
- 'docs/**'
workflow_dispatch:

permissions: read-all
Expand Down
48 changes: 48 additions & 0 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 5568307

Please sign in to comment.