Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check for doc changes when running ci #93

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,27 @@ jobs:
CHART_LOCATION: ./charts/bindplane
CHART_VALUES: ./charts/bindplane/values.yaml

docs:
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Install Helm Docs
run: |
curl -L -o helm-docs.deb https://github.com/norwoodj/helm-docs/releases/download/v1.11.0/helm-docs_1.11.0_Linux_amd64.deb
sudo apt-get install -f ./helm-docs.deb

- name: Update Docs
run: helm-docs

- run: git status

- name: Assert No Diff
run: bash .github/workflows/scripts/assert-no-diff.sh

integration:
runs-on: ubuntu-20.04
strategy:
Expand Down
22 changes: 22 additions & 0 deletions .github/workflows/scripts/assert-no-diff.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/usr/bin/env bash
# Copyright observIQ, Inc.
#
# Licensed 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.

set -e

if ! git diff --exit-code --quiet; then
echo "ERROR: Uncommitted changes detected. Please commit or stash your changes before running this script."
echo "changes: $(git diff --name-only)"
exit 1
fi
Loading