Add helm-docs + clean up #30
Merged
Conversation
This file contains hidden or 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
* Includes `act_pull_request.json` to ignore during version control. * Helps streamline local testing of GitHub Actions. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Set `validate-maintainers` and `check-version-increment` to true in `helm-lint.yaml`. * Cleaned up formatting in `helm-lint.yaml` workflow file for consistency. * Removed unused version bump check steps from the workflow. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Created a new `Makefile` for managing dependencies and installation of `helm-docs`. * Added a `README.md.gotmpl` file to provide an overview of the project, including structure and contribution guidelines. * Updated `.gitignore` to include the `bin` directory. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Introduced a new Makefile target `generate-readme` that runs `helm-docs` to generate the README.md file. * This enhances documentation automation and ensures the README is up-to-date with the latest chart values. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
- Improved comment formatting for better readability. - Enhanced descriptions for `prometheusRules` and `dashboards` sections. - Updated version in `Chart.yaml` from `1.2.2` to `1.2.3`. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Introduced a new GitHub Actions workflow to automate the generation of `README.md` for the Helm charts. * The workflow triggers on pull requests affecting `charts/kubernetes-operations/values.yaml`. * It checks if the `README.md` is outdated and fails the job if updates are needed. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
…H` detection * Simplified the architecture detection by using `uname -m` directly. * Updated the `HELM_DOCS_REPO` variable to reflect the new method of determining the architecture. * Added `-f` flag to `curl` command for better error handling during download. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Clarified comment for `labels` under `prometheusRules` to indicate it is a test. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Changed the path in the `git diff` command to check for updates in `README.md` directly. * This simplifies the check by removing the specific directory reference. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Removed extraneous text from the comment for clarity. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
…tainer name * Improved clarity of comments in `values.yaml` for `prometheusRules.annotations`. * Standardized maintainer name format in `Chart.yaml`. * Enhanced description for `prometheusRules.annotations` in `README.md`. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
- Introduced a new `.PHONY` target for `lint` to facilitate linting with a specified configuration. - Ensures code quality and adherence to standards in the project. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Improved clarity of the error message when README.md is outdated. * Encourages users to run `make generate-readme` to update the PR. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Updated the workflow to separate the display of the README.md error and the failure step. * Improved clarity in the Helm Docs Check workflow for better maintainability. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Simplified the error message for outdated `README.md` in the GitHub Actions workflow. * Removed redundant step that exited with an error if the README was outdated. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Updated the step name from `Display README.md error` to `Helm-Docs Check` for better understanding of its purpose. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Clarified the comment for `labels` under `prometheusRules` in `values.yaml`. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
richardtief
reviewed
May 9, 2025
Member
richardtief
left a comment
richardtief
left a comment
There was a problem hiding this comment.
Thanks. Looks reasonable to me.
* Added missing dashes in comments for consistency. * Corrected indentation for the `create` field under `dashboards`. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
* Updated the `paths-ignore` section to exclude 'README.md.gotmpl' from license checks. * This change helps streamline the license validation process by ignoring template files. Signed-off-by: Akshay Iyyadurai Balasundaram <akshay.iyyadurai.balasundaram@sap.com>
Closed
13 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.