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

doc: Procedure to Publish Operator on OperatorHub #225

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adambkaplan
Copy link
Member

@adambkaplan adambkaplan commented Jul 8, 2024

Changes

Add a procedure and script to publish an operator release to the upstream k8s community operators OperatorHub. The script requires the user to fork the upstream k8s operators repsository and afterwards submit a pull request by hand.

In the future this procedure/script can be added to our release automation so when an operator release is published, we initiate the process to update the upstream OperatorHub catalog.

Fixes #132

/kind documentation

Submitter Checklist

  • Includes tests if functionality changed/was added
  • Includes docs if changes are user-facing
  • Set a kind label on this PR
  • Release notes block has been filled in, or marked NONE

See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.

Release Notes

NONE

@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 8, 2024
@openshift-ci openshift-ci bot added release-note-none kind/documentation Categorizes issue or PR as related to documentation. labels Jul 8, 2024
@openshift-ci openshift-ci bot requested review from jkhelil and qu1queee July 8, 2024 18:19
@adambkaplan adambkaplan added this to the release-v0.14.0 milestone Jul 8, 2024
@adambkaplan adambkaplan force-pushed the release-procedure-operatorhub branch from 70d8acb to d36e134 Compare July 9, 2024 14:36
@pull-request-size pull-request-size bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 9, 2024
@adambkaplan
Copy link
Member Author

cc @HeavyWombat @SaschaSchwarze0 @ayushsatyam146 can one of you please review? I'd like to use the script for the v0.14.0 operator release. Thanks!

@ayushsatyam146
Copy link
Contributor

@adambkaplan this looks good but I don't think I can verify it since I don't have Approver/Maintainer permissions.

@adambkaplan
Copy link
Member Author

/approve

I think I can self-approve. Needs /lgtm from a community member.

Copy link
Contributor

openshift-ci bot commented Dec 13, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adambkaplan

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

The pull request process is described here

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 Dec 13, 2024
@ayushsatyam146
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 19, 2024
Add a procedure and script to publish an operator release to the
upstream k8s community operators OperatorHub. The script requires the
user to fork the upstream k8s operators repsository and afterwards
submit a pull request by hand. The script also supports releasing to
any catalog that uses the OperatorHub file structure.

In the future this procedure/script can be added to our release
automation so when an operator release is published, we initiate the
process to update the upstream OperatorHub catalog.

Co-authored-by: Sascha Schwarze <schwarzs@de.ibm.com>
Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
@adambkaplan
Copy link
Member Author

Moving this to v0.15.0. I'm going to experiment with the script in this PR on the v0.14.0 release to make sure it works.

Upstream has been moving towards using file-based catalogs, so the script might be obsolete.

@adambkaplan adambkaplan force-pushed the release-procedure-operatorhub branch from eb3e755 to 2b89b56 Compare December 20, 2024 16:52
Copy link
Contributor

openshift-ci bot commented Dec 20, 2024

New changes are detected. LGTM label has been removed.

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Dec 20, 2024
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. kind/documentation Categorizes issue or PR as related to documentation. release-note-none size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Document/automate how to add/release the operator to operatorhub
3 participants