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

fix(plugins): rename NoHelmChartTestFailuresCondition to HelmChartTestSucceededCondition #748

Merged
merged 16 commits into from
Nov 20, 2024

Conversation

ibakshay
Copy link
Contributor

The current status condition NoHelmChartTestFailures uses a double negative that makes it difficult to understand at a glance. Based on user feedback, we're renaming it to be more intuitive and direct.

This change makes the status condition:

  • More straightforward to interpret
  • Easier to understand without having to process double negatives

The functionality remains the same - the condition indicates whether the Helm chart tests is executed successfully.

Signed-off-by: Akshay Iyyadurai Balasundaram [email protected]

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

  • Related Issue # (issue)
  • Closes # (issue)
  • Fixes # (issue)

Remove if not applicable

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help
  • Separate ticket for tests # (issue/pr)

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Added to documentation?

  • 📜 README.md
  • 🤝 Documentation pages updated
  • 🙅 no documentation needed
  • (if applicable) generated OpenAPI docs for CRD changes

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

…tSucceededCondition

Signed-off-by: Akshay Iyyadurai Balasundaram <[email protected]>
@ibakshay ibakshay requested a review from a team as a code owner November 18, 2024 11:41
@ibakshay ibakshay self-assigned this Nov 18, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 18, 2024
Copy link
Contributor

@IvoGoman IvoGoman left a comment

Choose a reason for hiding this comment

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

This will add the new HelmChartTestSucceeded condition to the status of a Plugin. However, the existing condition will not be removed. To avoid manual patching of the existing Plugins, I would suggest removing the old condition via the controller first. Once this is rolled out, the logic can be removed again.

pkg/controllers/plugin/helm_chart_test_controller.go Outdated Show resolved Hide resolved
@ibakshay ibakshay changed the title fix(plugins): rename NoHelmChartTestFailuresCondition to HelmChartTestSucceededCondition fix(plugins): rename NoHelmChartTestFailuresCondition to HelmChartTestSucceededCondition Nov 18, 2024
@ibakshay
Copy link
Contributor Author

This will add the new HelmChartTestSucceeded condition to the status of a Plugin. However, the existing condition will not be removed. To avoid manual patching of the existing Plugins, I would suggest removing the old condition via the controller first. Once this is rolled out, the logic can be removed again.

This is a great suggestion. I have done as you have suggested and I have also added some tests :)
Ref: 862427e

Copy link
Contributor

@IvoGoman IvoGoman left a comment

Choose a reason for hiding this comment

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

I have tracked the removal of the deprecated Condition here: #754

@IvoGoman IvoGoman changed the title fix(plugins): rename NoHelmChartTestFailuresCondition to HelmChartTestSucceededCondition fix(plugins): rename NoHelmChartTestFailuresCondition to HelmChartTestSucceededCondition Nov 19, 2024
@ibakshay
Copy link
Contributor Author

@IvoGoman Why does the CI and other GHA workflows have not run for this PR?

@IvoGoman
Copy link
Contributor

@IvoGoman Why does the CI and other GHA workflows have not run for this PR?

This is a feature of Github Action, and should be fixed with #756. TL;DR; only when using a PAT a commit will trigger the workflows.

@ibakshay
Copy link
Contributor Author

@IvoGoman Why does the CI and other GHA workflows have not run for this PR?

This is a feature of Github Action, and should be fixed with #756. TL;DR; only when using a PAT a commit will trigger the workflows.

Ah I see..
So, there wont be CI trigger when there is a commit to generate the CRD API Docs?
So, that means I am good to merge this PR, right?

@IvoGoman
Copy link
Contributor

@IvoGoman Why does the CI and other GHA workflows have not run for this PR?

This is a feature of Github Action, and should be fixed with #756. TL;DR; only when using a PAT a commit will trigger the workflows.

Ah I see.. So, there wont be CI trigger when there is a commit to generate the CRD API Docs? So, that means I am good to merge this PR, right?

There is still a linter issue open: https://github.com/cloudoperators/greenhouse/actions/runs/11897250768/job/33189959724#step:4:205

@abhijith-darshan
Copy link
Contributor

@IvoGoman Why does the CI and other GHA workflows have not run for this PR?

This is a feature of Github Action, and should be fixed with #756. TL;DR; only when using a PAT a commit will trigger the workflows.

Ah I see.. So, there wont be CI trigger when there is a commit to generate the CRD API Docs? So, that means I am good to merge this PR, right?

You can see the status check for the commit before CRD API commit where the checks are failing.

ibakshay and others added 2 commits November 20, 2024 10:42
@IvoGoman IvoGoman changed the title fix(plugins): rename NoHelmChartTestFailuresCondition to HelmChartTestSucceededCondition fix(plugins): rename NoHelmChartTestFailuresCondition to HelmChartTestSucceededCondition Nov 20, 2024
@ibakshay ibakshay merged commit 20e2c9f into main Nov 20, 2024
2 checks passed
@ibakshay ibakshay deleted the improve-plugin-test branch November 20, 2024 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-apis documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants