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

Misformatted OpenShift OperatorHub registry operator bundle entry #1354

Closed
2 tasks
michael-valdron opened this issue Nov 17, 2023 · 9 comments
Closed
2 tasks
Assignees
Labels
area/registry Devfile registry for stacks and infrastructure area/releng Release engineering kind/bug Something isn't working severity/blocker Issues that prevent developers from working

Comments

@michael-valdron
Copy link
Member

michael-valdron commented Nov 17, 2023

Which area this feature is related to?

/kind bug

Which area this bug is related to?

/area registry
/area releng

What versions of software are you using?

Go project

Operating System and version: N/A

Go Pkg Version: 1.19

Web browser

Operating System and version: RHEL 8.8

Browser name and version: Firefox 115.4.0esr (64-bit)

Bug Summary

Describe the bug:

Registry operator bundle entry under the OpenShift OperatorHub catalog has the following issues:

  • Missing icon
  • Misformatted code blocks, missing new lines

Original findings comment: #1301 (comment)

To Reproduce:

  1. Go to OpenShift 4.12 or 4.13 web console
  2. Go to Administrator user perspective
  3. Under "Operators/OperatorHub" find the "Devfile Registry Operator" entry and open it
  4. Under the entry page you should observe no icon and Basic Usage code block is missing new lines

Expected behavior

There should be an icon and code blocks should have new lines as seen under the OperatorHub.io entry page: https://operatorhub.io/operator/registry-operator

Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable

OpenShift 4 13 bundle entry

Additional context

Any workaround?

N/A

Suggestion on how to fix the bug

@michael-valdron michael-valdron self-assigned this Nov 17, 2023
@openshift-ci openshift-ci bot added kind/bug Something isn't working area/registry Devfile registry for stacks and infrastructure area/releng Release engineering labels Nov 17, 2023
@michael-valdron michael-valdron moved this to To Do 📝 in Devfile Project Nov 17, 2023
@michael-valdron michael-valdron added the severity/blocker Issues that prevent developers from working label Nov 17, 2023
@michael-valdron michael-valdron moved this from To Do 📝 to In Progress 🚧 in Devfile Project Nov 17, 2023
@michael-valdron
Copy link
Member Author

Change block starting on config/manifests/bases/registry-operator.clusterserviceversion.yaml#L246 to be single lined

Basing off of operators/ecr-secret-operator/0.4.1/manifests/ecr-secret-operator.clusterserviceversion.yaml#L90

Update markdown of description to fix multi-line problems in Basic usage code block

Based off not seeing extra white space at beginning of the code block operators/ecr-secret-operator/0.4.1/manifests/ecr-secret-operator.clusterserviceversion.yaml#L74, config/manifests/bases/registry-operator.clusterserviceversion.yaml#L240 has extra white space before starting the code block and at each indentation level.

@michael-valdron
Copy link
Member Author

Registry operator PR is ready for review: devfile/registry-operator#62

@michael-valdron
Copy link
Member Author

michael-valdron commented Nov 17, 2023

Registry operator PR is ready for review: devfile/registry-operator#62

Sized this issue to amount of time it took to open this PR (one day).

@michael-valdron
Copy link
Member Author

devfile/registry-operator#62 has been merged and release PR that includes these changes is ready for review: devfile/registry-operator#63

@michael-valdron
Copy link
Member Author

devfile/registry-operator#63 release changes have been merged and new release has been cut. Performing updates to publications on OperatorHub.io and OpenShift embedded OperatorHub catalog.

@michael-valdron michael-valdron moved this from In Review 👀 to In Progress 🚧 in Devfile Project Nov 20, 2023
@michael-valdron
Copy link
Member Author

OperatorHub.io PR is ready for review: k8s-operatorhub/community-operators#3562

@michael-valdron
Copy link
Member Author

OpenShift OperatorHub catalog PR is ready for review: redhat-openshift-ecosystem/community-operators-prod#3641

@michael-valdron
Copy link
Member Author

OpenShift OperatorHub catalog PR is ready for review: redhat-openshift-ecosystem/community-operators-prod#3641

PRs are merged, confirming if the fix under the new release corrected these problems.

@michael-valdron
Copy link
Member Author

PR fix devfile/registry-operator#62 part of v0.2.0 release confirmed to resolve this issue:

image

@github-project-automation github-project-automation bot moved this from In Review 👀 to Done ✅ in Devfile Project Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/registry Devfile registry for stacks and infrastructure area/releng Release engineering kind/bug Something isn't working severity/blocker Issues that prevent developers from working
Projects
Status: Done ✅
Development

No branches or pull requests

1 participant