Add `generate bundle --ignore-if-only-created-at-changed` option #6419

kaovilai · 2023-05-04T07:12:11Z

Signed-off-by: Tiger Kaovilai [email protected]

Description of the change:
Add ability to ignore bundle updates on generate bundle command if createdAt timestamp is the only change.

The flag to use is --ignore-if-only-created-at-changed.

Motivation for the change:

2. We can define a constant. As part of the testdata generation process we replace the createdAt value in the generated CSV with this constant. This should prevent the git diff check from failing solely because of the createdAt value.

Number 2 probably makes more sense then. I assume the constant and code changes for the testdata generation should be under the hack/ directory?

from PR
This is indeed a hack. A constant only works for test data. For a real operators repo, we would want the createdAt updated when there are changes in config/. It should be possible to simply in CI check if config/ has become out of sync with bundle/ by running make bundle in CI and diffing the bundle without hacky workarounds noted in #6285.

The only other explanation that would make sense for not honoring this issue is if the suggestion is to add bundle/ to .gitignore which further hides the resulting bundle CSV from version control and makes it harder to track down issues.

Checklist

If the pull request includes user-facing changes, extra documentation is required:

Add a new changelog fragment in changelog/fragments (see changelog/fragments/00-template.yaml)
Add or update relevant sections of the docs website in website/content/en/docs

Fix #6285

kaovilai · 2023-05-04T07:19:04Z

/cc @redhatrises

openshift-ci · 2023-05-04T07:19:06Z

@kaovilai: GitHub didn't allow me to request PR reviews from the following users: redhatrises.

Note that only operator-framework members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @redhatrises

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/test-infra repository.

Signed-off-by: Tiger Kaovilai <[email protected]>

internal/cmd/operator-sdk/generate/bundle/cmd.go

Signed-off-by: Tiger Kaovilai <[email protected]>

varshaprasad96 · 2023-06-05T10:15:59Z

internal/generate/clusterserviceversion/clusterserviceversion.go

-
+	// If a reader is set, and there is a flag to not update createdAt, then
+	// set the CSV's createdAt to the previous CSV's createdAt if its the only change.
+	if g.ignoreIfOnlyCreatedAtChanged && g.getReader != nil {


This shouldn't happen of overwrite is set to false. If overwrite is explicitly set to false, and ignoreIfOnlyCreatedAtChanged is passed then we should possibly error out. If not, that defeats the purpose of us tracking createdAt to see the latest changes in bundles. It would be helpful to add that check here.

varshaprasad96 · 2023-06-05T10:27:13Z

internal/generate/clusterserviceversion/clusterserviceversion.go

+			// Set WebhookDefinitions if nil to avoid diffing on it
+			if prevCSV.Spec.WebhookDefinitions == nil {
+				prevCSV.Spec.WebhookDefinitions = []v1alpha1.WebhookDescription{}
+			}
+			if csvWithoutCreatedAtChange.ObjectMeta.Annotations == nil {
+				csvWithoutCreatedAtChange.ObjectMeta.Annotations = map[string]string{}
+			}
+			csvWithoutCreatedAtChange.ObjectMeta.Annotations["createdAt"] = prevCSV.ObjectMeta.Annotations["createdAt"]


We do have the code for walking through the input directories, collecting the manifests and unmarshalling it into the CSV in here. We should be able to fetch the createdAt at that step from annotations, and accordingly set it in here. This would avoid us doing the comparisons with webhooks done below.

Another option is, once we identify the CSV manifest, we can unmarshal it into a runtime.Object as done in this PR, and pass it on through the collector, to apply it in here.

That would make sure that we are performing all operations related to inputs being passed on through flags in place and not read the input CSV multiple times.

Wdyt?

That sounds more efficient. Will have a look. Thanks!

openshift-bot · 2023-09-04T01:00:17Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

kaovilai · 2023-09-27T20:31:51Z

/lifecycle frozen

openshift-ci · 2023-09-27T20:31:52Z

@kaovilai: The lifecycle/frozen label cannot be applied to Pull Requests.

In response to this:

/lifecycle frozen

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/test-infra repository.

openshift-bot · 2023-10-28T00:30:27Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

kaovilai · 2023-10-29T04:42:42Z

/lifecycle frozen

openshift-ci · 2023-10-29T04:42:43Z

@kaovilai: The lifecycle/frozen label cannot be applied to Pull Requests.

In response to this:

/lifecycle frozen

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/test-infra repository.

kaovilai · 2023-10-30T18:14:17Z

/remove-lifecycle rotten

openshift-bot · 2024-01-29T01:00:25Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot · 2024-02-29T08:30:06Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

kaovilai · 2024-02-29T17:26:53Z

closing as no longer working on this. takeover as necessary.

openshift-ci bot requested review from everettraven and rashmigottipati May 4, 2023 07:12

kaovilai force-pushed the fix6285 branch from 65abc92 to 5747337 Compare May 4, 2023 07:16

kaovilai force-pushed the fix6285 branch 4 times, most recently from 5be0ea2 to 88a1c9d Compare May 4, 2023 14:38

Add generate bundle --ignore-if-only-createdAt option

ef961e0

Signed-off-by: Tiger Kaovilai <[email protected]>

kaovilai force-pushed the fix6285 branch from 88a1c9d to ef961e0 Compare May 4, 2023 14:43

ncdc reviewed May 9, 2023

View reviewed changes

internal/cmd/operator-sdk/generate/bundle/cmd.go Outdated Show resolved Hide resolved

kaovilai requested a review from ncdc May 9, 2023 14:45

ignore-if-only-created-at-changed

b392bb7

Signed-off-by: Tiger Kaovilai <[email protected]>

kaovilai force-pushed the fix6285 branch from 9a2f231 to b392bb7 Compare May 9, 2023 14:48

kaovilai changed the title ~~Add generate bundle --ignore-if-only-createdAt option~~ Add generate bundle --ignore-if-only-created-at-changed option May 9, 2023

varshaprasad96 requested changes Jun 5, 2023

View reviewed changes

carlosedp mentioned this pull request Aug 9, 2023

Re-enable check manifest action carlosedp/lbconfig-operator#178

Closed

desmax74 mentioned this pull request Aug 30, 2023

[KOGITO-9428]Update Operator SDK from 1.25 to 1.31 apache/incubator-kie-kogito-serverless-operator#165

Closed

2 tasks

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 4, 2023

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Oct 28, 2023

openshift-ci bot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Oct 30, 2023

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 29, 2024

ncdc removed their request for review January 29, 2024 17:41

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 29, 2024

kaovilai closed this Feb 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `generate bundle --ignore-if-only-created-at-changed` option #6419

Add `generate bundle --ignore-if-only-created-at-changed` option #6419

kaovilai commented May 4, 2023 •

edited

Loading

kaovilai commented May 4, 2023

openshift-ci bot commented May 4, 2023

varshaprasad96 Jun 5, 2023

kaovilai Jun 5, 2023

varshaprasad96 Jun 5, 2023

kaovilai Jun 5, 2023

openshift-bot commented Sep 4, 2023

kaovilai commented Sep 27, 2023

openshift-ci bot commented Sep 27, 2023

openshift-bot commented Oct 28, 2023

kaovilai commented Oct 29, 2023

openshift-ci bot commented Oct 29, 2023

kaovilai commented Oct 30, 2023

openshift-bot commented Jan 29, 2024

openshift-bot commented Feb 29, 2024

kaovilai commented Feb 29, 2024

Add generate bundle --ignore-if-only-created-at-changed option #6419

Add generate bundle --ignore-if-only-created-at-changed option #6419

Conversation

kaovilai commented May 4, 2023 • edited Loading

kaovilai commented May 4, 2023

openshift-ci bot commented May 4, 2023

varshaprasad96 Jun 5, 2023

Choose a reason for hiding this comment

kaovilai Jun 5, 2023

Choose a reason for hiding this comment

varshaprasad96 Jun 5, 2023

Choose a reason for hiding this comment

kaovilai Jun 5, 2023

Choose a reason for hiding this comment

openshift-bot commented Sep 4, 2023

kaovilai commented Sep 27, 2023

openshift-ci bot commented Sep 27, 2023

openshift-bot commented Oct 28, 2023

kaovilai commented Oct 29, 2023

openshift-ci bot commented Oct 29, 2023

kaovilai commented Oct 30, 2023

openshift-bot commented Jan 29, 2024

openshift-bot commented Feb 29, 2024

kaovilai commented Feb 29, 2024

Add `generate bundle --ignore-if-only-created-at-changed` option #6419

Add `generate bundle --ignore-if-only-created-at-changed` option #6419

kaovilai commented May 4, 2023 •

edited

Loading