Skip to content

Conversation

@ramperher
Copy link
Contributor

@ramperher ramperher commented May 30, 2025

SUMMARY

As agreed in the last Certification sync, and with the idea of simplifying the certsuite role, updating the oldest supported version to v5.5.0, where the last breaking changes were integrated (i.e. the update of the intrusive label).

ISSUE TYPE
  • Technical debt
Tests

Test-Hints: no-check

@ramperher ramperher requested a review from a team as a code owner May 30, 2025 13:57
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 30, 2025

📝 Walkthrough

Walkthrough

This update raises the minimum supported Certsuite version to v5.5.0, removes version-specific logic and variables, and streamlines related documentation and configuration. Version checks and conditional code paths are simplified, making certain options and flags apply universally rather than being gated by specific Certsuite versions.

Changes

Files/Paths Change Summary
roles/k8s_best_practices_certsuite/README.md Updated documentation to reflect new minimum Certsuite version, removed version-specific notes and variables.
roles/k8s_best_practices_certsuite/defaults/main.yml Removed kbpc_non_intrusive_only variable and related deprecation comments.
roles/k8s_best_practices_certsuite/tasks/pre-run.yml Updated version check to require Certsuite v5.5.0 or newer.
roles/k8s_best_practices_certsuite/tasks/tests.yml Removed version-based conditions; simplified command construction and task execution guards.
roles/k8s_best_practices_certsuite/templates/certsuite_config.yml.j2 Simplified conditional logic for API config; always sets certain fields to empty strings for supported versions.

Possibly related PRs

Suggested reviewers

  • rajchiluveru
  • sebrandon1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@softwarefactory-project-zuul
Copy link

@ramperher ramperher force-pushed the certsuite-backwards-compatibility-v5.5.0 branch from fb5b60f to 05818bb Compare May 30, 2025 14:00
@softwarefactory-project-zuul
Copy link

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🔭 Outside diff range comments (1)
roles/k8s_best_practices_certsuite/tasks/tests.yml (1)

2-13: ⚠️ Potential issue

Restore directory creation for config and result mounts
The tasks that created {{ kbpc_certsuite_dir }}/config_files and result_files were removed, but the subsequent podman run mounts will fail if those host paths don’t exist. Please reintroduce file tasks to ensure these directories are present before mounting.

🧹 Nitpick comments (2)
roles/k8s_best_practices_certsuite/README.md (2)

12-12: Use "until" instead of "till" in the description
For a more formal tone, replace "till" with "until" in the kbpc_version description.

🧰 Tools
🪛 LanguageTool

[style] ~12-~12: Consider using the more formal “until”.
Context: ... version. The role supports from v5.5.0 till the latest stable version. HEAD version...

(TILL)


[uncategorized] ~12-~12: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: .... HEAD version (in the main branch) can be also used, but it is not guaranteed a comple...

(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)


143-143: Add missing article "the" for clarity
Consider updating to "kbpc_cwe_apikey_path: the path to the file containing the CWE Hydra API key..." to improve readability.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~143-~143: You might be missing the article “the” here.
Context: ...d to configure these two variables with proper values: - kbpc_cwe_apikey_path: path...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2d12927 and 05818bb.

📒 Files selected for processing (5)
  • roles/k8s_best_practices_certsuite/README.md (4 hunks)
  • roles/k8s_best_practices_certsuite/defaults/main.yml (0 hunks)
  • roles/k8s_best_practices_certsuite/tasks/pre-run.yml (1 hunks)
  • roles/k8s_best_practices_certsuite/tasks/tests.yml (1 hunks)
  • roles/k8s_best_practices_certsuite/templates/certsuite_config.yml.j2 (0 hunks)
💤 Files with no reviewable changes (2)
  • roles/k8s_best_practices_certsuite/defaults/main.yml
  • roles/k8s_best_practices_certsuite/templates/certsuite_config.yml.j2
🧰 Additional context used
🪛 LanguageTool
roles/k8s_best_practices_certsuite/README.md

[style] ~12-~12: Consider using the more formal “until”.
Context: ... version. The role supports from v5.5.0 till the latest stable version. HEAD version...

(TILL)


[uncategorized] ~12-~12: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: .... HEAD version (in the main branch) can be also used, but it is not guaranteed a comple...

(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)


[uncategorized] ~143-~143: You might be missing the article “the” here.
Context: ...d to configure these two variables with proper values: - kbpc_cwe_apikey_path: path...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...proper values: - kbpc_cwe_apikey_path: path to CWE Hydra API key, generated be...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~146-~146: Loose punctuation mark.
Context: ...n you create it. - kbpc_cwe_project_id: CNF Certification project ID that is pr...

(UNLIKELY_OPENING_PUNCTUATION)

🪛 markdownlint-cli2 (0.17.2)
roles/k8s_best_practices_certsuite/README.md

145-145: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Sanity Check (stable-2.9)
  • GitHub Check: Sanity Check (stable-2.17)
🔇 Additional comments (2)
roles/k8s_best_practices_certsuite/tasks/pre-run.yml (1)

9-15: Minimum supported Certsuite version updated to 5.5.0
The version check and failure message have been correctly updated to enforce v5.5.0 as the new lower bound.

roles/k8s_best_practices_certsuite/tasks/tests.yml (1)

60-63: Include Connect API flags whenever credentials are defined
The version-based gating for --connect-api-key and --connect-project-id has been removed in favor of checking variable presence, which aligns with the new minimum version policy.

@dcibot
Copy link
Collaborator

dcibot commented May 30, 2025

Copy link
Contributor

@manurodriguez manurodriguez left a comment

Choose a reason for hiding this comment

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

LGTM

@ramperher ramperher added this pull request to the merge queue Jun 2, 2025
Merged via the queue into main with commit 3943ccf Jun 2, 2025
8 checks passed
@ramperher ramperher deleted the certsuite-backwards-compatibility-v5.5.0 branch June 2, 2025 16:42
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.

4 participants