Skip to content

fix: small typos in comments in types.go#2804

Open
gonmmarques wants to merge 2 commits intoopenshift:masterfrom
gonmmarques:master
Open

fix: small typos in comments in types.go#2804
gonmmarques wants to merge 2 commits intoopenshift:masterfrom
gonmmarques:master

Conversation

@gonmmarques
Copy link
Copy Markdown

No description provided.

@openshift-merge-bot
Copy link
Copy Markdown
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 15, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ca48b321-eb8b-42b3-9adb-86681c696b51

📥 Commits

Reviewing files that changed from the base of the PR and between 1e652a1 and 3d57b9d.

⛔ Files ignored due to path filters (5)
  • openapi/generated_openapi/zz_generated.openapi.go is excluded by !openapi/**, !**/zz_generated*
  • security/v1/zz_generated.crd-manifests/0000_03_config-operator_01_securitycontextconstraints.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/AAA_ungated.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • security/v1/zz_generated.featuregated-crd-manifests/securitycontextconstraints.security.openshift.io/UserNamespacesPodSecurityStandards.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • security/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
📒 Files selected for processing (1)
  • payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints.crd.yaml
✅ Files skipped from review due to trivial changes (1)
  • payload-manifests/crds/0000_03_config-operator_01_securitycontextconstraints.crd.yaml

📝 Walkthrough

Walkthrough

Corrected two spelling errors in documentation strings: in security/v1/types.go and the CRD YAML (payload-manifests/..._securitycontextconstraints.crd.yaml) the DefaultAddCapabilities comment was changed from "capabiility" to "capability" and the SeccompProfiles description was changed from "specifid" to "specified". No code logic, type definitions, field names, JSON/protobuf tags, validation rules, or functional behavior were modified.

🚥 Pre-merge checks | ✅ 8 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title claims the changes are limited to types.go, but the PR also modifies the CRD YAML file with identical spelling corrections. Revise the title to reflect all modified files, such as 'fix: correct spelling errors in comments and CRD descriptions' or 'fix: typos in types.go and securitycontextconstraints.crd.yaml'.
Description check ⚠️ Warning No description was provided; the pull request lacks any explanation of the changes or their context. Add a description explaining the spelling corrections made across both files and their purpose.
✅ Passed checks (8 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Stable And Deterministic Test Names ✅ Passed The custom check for Stable and Deterministic Test Names applies only to Ginkgo test declarations. This PR modifies only type definitions and YAML schema files with no test files affected.
Test Structure And Quality ✅ Passed This PR modifies only documentation/comments (spelling corrections) in a Go types file and Kubernetes CRD YAML schema file with no Ginkgo test code changes.
Microshift Test Compatibility ✅ Passed PR only fixes spelling errors in comments and documentation; no Ginkgo e2e tests added, so MicroShift compatibility check is not applicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed PR contains only spelling corrections in comments and documentation; no new Ginkgo e2e tests added, so SNO compatibility check is not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed This PR only corrects spelling errors in comments and documentation strings without introducing scheduling constraints or modifying deployment manifests.
Ote Binary Stdout Contract ✅ Passed Pull request only modifies comment text and YAML schema descriptions in API definition files with no executable code or process-level entry points affected.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed This PR does not add any new Ginkgo e2e tests. Only type definitions and CRD documentation are modified with spelling and wording corrections, making the check not applicable.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 15, 2026

Hello @gonmmarques! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 15, 2026
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 15, 2026

Hi @gonmmarques. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link
Copy Markdown
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @gonmmarques

It looks like this needs to re-generate the generated files that are impacted by this change still.

Running PROTO_OPTIONAL=true make update should do the trick.

@openshift-ci openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 16, 2026
@gonmmarques
Copy link
Copy Markdown
Author

Thanks for the PR @gonmmarques

It looks like this needs to re-generate the generated files that are impacted by this change still.

Running PROTO_OPTIONAL=true make update should do the trick.

Hello @everettraven

Thanks for the hint! I ran the command and committed the changes.

@everettraven
Copy link
Copy Markdown
Contributor

/lgtm
/approve

/ok-to-test

@openshift-ci openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 16, 2026
@everettraven
Copy link
Copy Markdown
Contributor

/verified by @everettraven

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Apr 16, 2026
@openshift-ci-robot
Copy link
Copy Markdown

@everettraven: This PR has been marked as verified by @everettraven.

Details

In response to this:

/verified by @everettraven

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2026
@openshift-merge-bot
Copy link
Copy Markdown
Contributor

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-aws-ovn
/test e2e-aws-ovn-hypershift
/test e2e-aws-ovn-hypershift-conformance
/test e2e-aws-ovn-techpreview
/test e2e-aws-serial-1of2
/test e2e-aws-serial-2of2
/test e2e-aws-serial-techpreview-1of2
/test e2e-aws-serial-techpreview-2of2
/test e2e-azure
/test e2e-gcp
/test e2e-upgrade
/test e2e-upgrade-out-of-change
/test minor-e2e-upgrade-minor

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 16, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: everettraven

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 16, 2026
@openshift-merge-bot
Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD 3c6b218 and 2 for PR HEAD 3d57b9d in total

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 16, 2026

@gonmmarques: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/verify-hypershift-integration 3d57b9d link true /test verify-hypershift-integration
ci/prow/verify 3d57b9d link true /test verify
ci/prow/e2e-aws-ovn-hypershift-conformance 3d57b9d link true /test e2e-aws-ovn-hypershift-conformance

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@gonmmarques
Copy link
Copy Markdown
Author

/retest-required

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants