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.

Sign up for GitHub

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

Jump to bottom

EVEREST-1513 | [CI] Add step to PR check to ensure generated docs are up-to-date #407

Merged
merged 7 commits into from
Nov 5, 2024
Merged

EVEREST-1513 | [CI] Add step to PR check to ensure generated docs are up-to-date #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e56f942
add step to ensure docs are up-to-date
mayankshah1607 Oct 31, 2024
9a277d5
test commit
mayankshah1607 Oct 31, 2024
a2164d0
Update docs
mayankshah1607 Oct 31, 2024
b6f61ac
bump version
mayankshah1607 Oct 31, 2024
c829e82
update docs
mayankshah1607 Oct 31, 2024
7946474
Merge branch 'main' into EVEREST-1513-ci-docs-check
mayankshah1607 Oct 31, 2024
d44e16c
Merge branch 'main' into EVEREST-1513-ci-docs-check
mayankshah1607 Nov 5, 2024
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
14 changes: 14 additions & 0 deletions .github/workflows/everest-pr-checks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ jobs:
uses: actions/checkout@v4
with:
fetch-depth: 0
sparse-checkout: |
.github/
charts/everest

- name: Check docs
run: |
cd charts/everest
make docs-gen
if git diff --quiet; then
echo "Docs are up to date."
else
echo "Docs are out of date. Please run 'make docs-gen' and commit the changes."
exit 1
fi

- name: Set up Helm
uses: azure/[email protected]
Expand Down
6 changes: 3 additions & 3 deletions charts/everest/Chart.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
dependencies:
- name: common
repository: file://charts/common
version: 0.0.2
version: 0.0.3
- name: everest-db-namespace
repository: file://charts/everest-db-namespace
version: 0.0.0
digest: sha256:c640ee1595ced2f8d4024f9f37b38d6ca685bc4edba9d451f9bcd56edc22ee23
generated: "2024-10-31T11:35:48.801214+05:30"
digest: sha256:99b7426a3f8df9d34dbdc6be2934e6bbde5351b5aa8f0ce4ce78ec18451c8b55
generated: "2024-10-31T16:32:12.88258+05:30"
2 changes: 1 addition & 1 deletion charts/everest/charts/common/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: common
description: A library chart for Everest containing common resources.
type: library
version: 0.0.2
version: 0.0.3
appVersion: "0.0.2"
maintainers:
- name: mayankshah1607
Expand Down
11 changes: 10 additions & 1 deletion charts/everest/charts/common/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# common

![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square)
![Version: 0.0.3](https://img.shields.io/badge/Version-0.0.3-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 0.0.2](https://img.shields.io/badge/AppVersion-0.0.2-informational?style=flat-square)

A library chart for Everest containing common resources.

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| mayankshah1607 | <[email protected]> | |
| oksana-grishchenko | <[email protected]> | |
| recharte | <[email protected]> | |
| michal-kralik | <[email protected]> | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)
6 changes: 3 additions & 3 deletions charts/everest/charts/everest-db-namespace/Chart.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dependencies:
- name: common
repository: file://../common
version: 0.0.2
digest: sha256:e26bbcf7da416e9ea599f57a116c90e4a8b38bb7293945ef17a4f5243043cd99
generated: "2024-10-31T11:35:45.12716+05:30"
version: 0.0.3
digest: sha256:9c473ddc333f399701ca42304b7c24defb59270a6e04d75254be0ccf6eec438a
generated: "2024-10-31T16:32:16.267628+05:30"
11 changes: 10 additions & 1 deletion charts/everest/charts/everest-db-namespace/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,20 @@

A sub-chart for provisioning Everest DB namespaces.

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| mayankshah1607 | <[email protected]> | |
| oksana-grishchenko | <[email protected]> | |
| recharte | <[email protected]> | |
| michal-kralik | <[email protected]> | |

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://../common | common | 0.0.1 |
| file://../common | common | 0.0.* |

## Values

Expand Down
Loading