Skip to content

Add simple CI usage documentation #970

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

TobiasCGoetz
Copy link

@TobiasCGoetz TobiasCGoetz commented Jun 20, 2025

Hi,

I added some basic documentation for using KubeLinter as part of a CI pipeline. While there is a Github Action available, I might not be the only one interested in running it elsewhere. I found the --fail-on-invalid-resource option especially important when dealing with manual changes to YAML files.

#965

@TobiasCGoetz TobiasCGoetz requested a review from rhybrillou as a code owner June 20, 2025 13:32
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @TobiasCGoetz - I've reviewed your changes - here's some feedback:

  • The JSON parsing snippet with grep/awk is brittle; consider using jq or the GitHub CLI to reliably fetch the latest release URL.
  • The relative link README.md##kubelinter-github-action may not render correctly—update it to a valid Markdown anchor or full URL for the GitHub Action.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The JSON parsing snippet with grep/awk is brittle; consider using `jq` or the GitHub CLI to reliably fetch the latest release URL.
- The relative link `README.md##kubelinter-github-action` may not render correctly—update it to a valid Markdown anchor or full URL for the GitHub Action.

## Individual Comments

### Comment 1
<location> `docs/using-kubelinter.md:65` </location>
<code_context>

+## Using KubeLinter as part of your CI pipeline
+
+If you're using Github, there's the [KubeLinter Github Action](README.md##kubelinter-github-action) available.
+
+Alternatively, you can grab the latest binary release with the following commands
</code_context>

<issue_to_address>
Correct 'Github' to 'GitHub' for proper branding.

Update all instances to 'GitHub' for consistency.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
If you're using Github, there's the [KubeLinter Github Action](README.md##kubelinter-github-action) available.
=======
If you're using GitHub, there's the [KubeLinter GitHub Action](README.md##kubelinter-github-action) available.
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Copy link

codecov bot commented Jun 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.66%. Comparing base (dbd7529) to head (47a5f8b).
Report is 126 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #970       +/-   ##
===========================================
- Coverage   62.36%   28.66%   -33.70%     
===========================================
  Files         197      209       +12     
  Lines        4854     5947     +1093     
===========================================
- Hits         3027     1705     -1322     
- Misses       1439     4126     +2687     
+ Partials      388      116      -272     
Flag Coverage Δ
unit 28.66% <ø> (-33.70%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant