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

File-based OLM catalog with history #1308

Merged
merged 10 commits into from
Jan 7, 2025
Merged

Conversation

MikeEdgar
Copy link
Member

@MikeEdgar MikeEdgar commented Dec 12, 2024

Closes #1307

This change introduces an automated file-based OLM catalog [1] to the project. Previously, the catalog was generated fresh with a single bundle included for the head of the current branch (snapshot workflow) or the release tag (release workflow). Here, we will keep the catalog files in source control and add/update the current/release version to the alpha channel during the release.

Additional OLM package channels could be added in the future, but only the alpha channel will use the automation. By using the maven-release-plugin preparation and completion hooks the previous -snapshot bundle name is updated to match the release, and the new `-snapshot is added as a replacement of the just-released version.

A check is also added to the integration workflow to ensure the current project version has an entry in the alpha channel.

Between releases, the current snapshot entry in the channel may be modified (i.e. change the replaces or add skips or skipRange[2]), but a package name matching the current project version will always be enforced.

[1] https://olm.operatorframework.io/docs/reference/file-based-catalogs
[2] https://olm.operatorframework.io/docs/concepts/olm-architecture/operator-catalog/creating-an-update-graph/

@MikeEdgar MikeEdgar marked this pull request as draft December 12, 2024 21:15
@MikeEdgar MikeEdgar force-pushed the issue-1307 branch 2 times, most recently from 20ac49b to fe7e1db Compare December 13, 2024 17:21
@MikeEdgar MikeEdgar marked this pull request as ready for review December 13, 2024 18:54
@MikeEdgar MikeEdgar changed the title [WIP] File-based OLM catalog with history File-based OLM catalog with history Dec 13, 2024
@MikeEdgar MikeEdgar force-pushed the issue-1307 branch 3 times, most recently from ff1603c to ab892e9 Compare December 20, 2024 16:22
@MikeEdgar MikeEdgar added this to the 0.6.0 milestone Dec 20, 2024
@MikeEdgar MikeEdgar requested a review from a team December 20, 2024 16:24
@MikeEdgar MikeEdgar enabled auto-merge (squash) January 7, 2025 15:15
Copy link

sonarqubecloud bot commented Jan 7, 2025

@MikeEdgar MikeEdgar merged commit 9883b2c into streamshub:main Jan 7, 2025
6 checks passed
@MikeEdgar MikeEdgar deleted the issue-1307 branch January 8, 2025 12:07
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.

Generate proper OLM catalog source
2 participants