From 20893fe5838104e3990b4733a912617251070f65 Mon Sep 17 00:00:00 2001 From: Shahzad Lone Date: Mon, 3 Jun 2024 20:55:46 -0400 Subject: [PATCH] PR: Add workflow to check http documentation --- .../workflows/check-http-documentation.yml | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .github/workflows/check-http-documentation.yml diff --git a/.github/workflows/check-http-documentation.yml b/.github/workflows/check-http-documentation.yml new file mode 100644 index 0000000000..e68471c162 --- /dev/null +++ b/.github/workflows/check-http-documentation.yml @@ -0,0 +1,52 @@ +# Copyright 2024 Democratized Data Foundation +# +# Use of this software is governed by the Business Source License +# included in the file licenses/BSL.txt. +# +# As of the Change Date specified in that file, in accordance with +# the Business Source License, use of this software will be governed +# by the Apache License, Version 2.0, included in the file +# licenses/APL.txt. + +# This workflow checks that all HTTP documentation is up to date. +# If the documentation is not up to date then this action will fail. +name: Check HTTP Documentation Workflow + +on: + pull_request: + branches: + - master + - develop + + push: + tags: + - 'v[0-9]+.[0-9]+.[0-9]+' + branches: + - master + - develop + +jobs: + check-http-documentation: + name: Check http documentation job + + runs-on: ubuntu-latest + + steps: + - name: Checkout code into the directory + uses: actions/checkout@v3 + + - name: Setup Go environment explicitly + uses: actions/setup-go@v3 + with: + go-version: "1.21" + check-latest: true + + - name: Try generating http documentation + run: make docs:http + + - name: Check no new changes exist + uses: tj-actions/verify-changed-files@v20 + with: + fail-if-changed: true + files: | + docs/website/references/http