forked from sourcenetwork/defradb
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PR: Add workflow to check http documentation
- Loading branch information
1 parent
6510585
commit 20893fe
Showing
1 changed file
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |