Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
124 changes: 124 additions & 0 deletions .claude/skills/openshift-rebase-update/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
---
name: openshift-rebase-update
description: Bumps openshift/api, openshift/library-go, openshift/client-go, and other openshift/* Go module dependencies in kueue-operator to their latest commits, re-vendors, regenerates code/manifests, and runs the full verification suite (build, vet, unit tests, lint). Use whenever asked to "rebase", "bump openshift deps", "update openshift/api", or similar dependency-refresh requests for this repo.
---

# OpenShift Dependency Rebase/Update

Updates this operator's `openshift/*` Go module dependencies to their latest
upstream commits and verifies nothing broke. Mirrors the manual workflow used
for bumping `openshift/api`.

## Which modules this covers

Check `go.mod` for the current set — typically:

- `github.com/openshift/api`
- `github.com/openshift/library-go`
- `github.com/openshift/client-go`
- `github.com/openshift/build-machinery-go`
- `github.com/openshift/jobset-operator`
- `github.com/openshift/lws-operator`

```bash
grep -n 'github.com/openshift/' go.mod
```

**Important:** `go.mod` may contain a `replace` directive pointing an
`openshift/*` module at a personal fork (e.g. a fork used to pick up an
unmerged upstream PR). Check for these before bumping:

```bash
grep -n '^replace' go.mod
```

If a target module is `replace`d by a fork, decide whether to:
- leave the replace as-is (fork still needed, e.g. PR not yet merged upstream), or
- point the replace at a newer fork commit / remove it if the PR has since merged into `openshift/library-go` proper.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is there a word missing after "if the PR has"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No I think that is proper english. It reads fine to me.


Do not silently drop a `replace` directive without confirming the underlying
PR has actually merged upstream.

## Steps

1. **Identify target modules.** Default to updating all `github.com/openshift/*`
direct dependencies unless the user specifies a subset.

2. **Bump each module to latest:**

```bash
go get github.com/openshift/api@latest
go get github.com/openshift/library-go@latest
go get github.com/openshift/client-go@latest
# ... repeat for other requested openshift/* modules
```

`go get @latest` follows the module's default branch tip (or a `replace`
target's branch tip if one is set). This will also pull in any required
transitive bumps (e.g. `k8s.io/api`, `k8s.io/apimachinery`).

3. **Tidy and re-vendor:**

```bash
go mod tidy
go mod vendor
```

4. **Check for accidental submodule drift.** `upstream/kueue/src` is a git
submodule and can show as modified even when unrelated to this task
(e.g. from a prior `git submodule update` elsewhere). Restore it unless the
task explicitly wants it moved:

```bash
git status --short upstream/kueue/src
git submodule update upstream/kueue/src # if unexpectedly dirty
```

5. **Regenerate manifests/generated code**, since API type changes can affect
CRDs, deepcopy, clients, listers, informers:

```bash
make generate
```

Review `git status --short` for changes under `manifests/`,
`pkg/generated/`, and `pkg/apis/.../zz_generated*.go`.

6. **Run the full verification suite:**

```bash
go build ./...
go vet ./...
make test-unit
make lint
```

Fix any compile errors from upstream API changes (renamed fields, removed
types, changed signatures) before proceeding. Common sources of breakage:
- `library-go` helper function signature changes
- `openshift/api` type/field renames or removals (check `zz_generated.deepcopy.go` diffs and callers)
- `client-go`/`applyconfiguration` generated code needing regeneration (step 5)

7. **Review the diff** before considering the task done:

```bash
git status --short | grep -v '^ M vendor/' # non-vendor changes worth a close look
git diff go.mod go.sum
```

Expect `go.mod`/`go.sum` version bumps, vendor tree churn (many files, this
is normal and doesn't need individual review), and possibly `manifests/`
or `pkg/generated/` diffs from regeneration. Flag anything unexpected
(e.g. unrelated submodule pointer changes, unrelated untracked files) to
the user rather than committing them.

## Notes

- `go get @latest` for pseudo-versioned modules (no tags) resolves to the
latest commit on the module's default branch as of that moment — safe to
re-run to pick up newer commits later.
- If `go build`/`make generate` fails with "inconsistent vendoring", it means
`go.mod` and `vendor/modules.txt` disagree; re-run `go mod vendor`.
- Do not hand-edit files under `vendor/`; always regenerate via `go mod vendor`.
- `make lint` uses golangci-lint v2 (30m timeout) — expect it to download the
pinned binary into `bin/` on first run.
Comment thread
kannon92 marked this conversation as resolved.
Resolved
66 changes: 32 additions & 34 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ require (
github.com/google/go-cmp v0.7.0
github.com/onsi/ginkgo/v2 v2.29.0
github.com/onsi/gomega v1.41.0
github.com/openshift/api v0.0.0-20260602150417-b13acc5743d1
github.com/openshift/build-machinery-go v0.0.0-20251023084048-5d77c1a5e5af
github.com/openshift/client-go v0.0.0-20260512113608-deb4dc54551a
github.com/openshift/jobset-operator v0.0.0-20260119121041-4eba0a5413f6
github.com/openshift/library-go v0.0.0-20260602175739-aa495601f7ee
github.com/openshift/lws-operator v0.0.0-20260117095057-194a9dea5308
github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.86.1
github.com/openshift/api v0.0.0-20260715165912-72066cc9718b
github.com/openshift/build-machinery-go v0.0.0-20260629141115-154a2b810491
github.com/openshift/client-go v0.0.0-20260715172546-dac61734e0ec
github.com/openshift/jobset-operator v0.0.0-20260711072835-3e31beea6ad3
github.com/openshift/library-go v0.0.0-20260715193157-1a5091f58ece
github.com/openshift/lws-operator v0.0.0-20260713164836-d1df299cdc58
github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.92.1
github.com/spf13/cobra v1.10.2
k8s.io/api v0.36.1
k8s.io/apiextensions-apiserver v0.36.1
k8s.io/apimachinery v0.36.1
k8s.io/client-go v0.36.1
k8s.io/code-generator v0.36.1
k8s.io/component-base v0.36.1
k8s.io/api v0.36.2
k8s.io/apiextensions-apiserver v0.36.2
k8s.io/apimachinery v0.36.2
k8s.io/client-go v0.36.2
k8s.io/code-generator v0.36.2
k8s.io/component-base v0.36.2
k8s.io/klog/v2 v2.140.0
k8s.io/kube-aggregator v0.35.2
k8s.io/utils v0.0.0-20260507154919-ff6756f316d2
sigs.k8s.io/controller-runtime v0.24.0
sigs.k8s.io/controller-tools v0.19.0
k8s.io/kube-aggregator v0.36.2
k8s.io/utils v0.0.0-20260707023825-cf1189d6abe3
sigs.k8s.io/controller-runtime v0.24.1
sigs.k8s.io/controller-tools v0.20.1
sigs.k8s.io/jobset v0.12.0
sigs.k8s.io/kueue v0.18.1
sigs.k8s.io/lws v0.8.0
Expand All @@ -52,7 +52,7 @@ require (
github.com/felixge/fgprof v0.9.4 // indirect
github.com/felixge/httpsnoop v1.0.4 // indirect
github.com/fsnotify/fsnotify v1.10.1 // indirect
github.com/fxamacker/cbor/v2 v2.9.0 // indirect
github.com/fxamacker/cbor/v2 v2.9.2 // indirect
github.com/go-logr/logr v1.4.3 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-logr/zapr v1.3.0 // indirect
Expand Down Expand Up @@ -117,19 +117,19 @@ require (
go.opentelemetry.io/proto/otlp v1.9.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.28.0 // indirect
go.yaml.in/yaml/v2 v2.4.3 // indirect
go.yaml.in/yaml/v2 v2.4.4 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.52.0 // indirect
golang.org/x/crypto v0.53.0 // indirect
golang.org/x/exp v0.0.0-20251219203646-944ab1f22d93 // indirect
golang.org/x/mod v0.35.0 // indirect
golang.org/x/net v0.55.0 // indirect
golang.org/x/mod v0.36.0 // indirect
golang.org/x/net v0.56.0 // indirect
golang.org/x/oauth2 v0.36.0 // indirect
golang.org/x/sync v0.20.0 // indirect
golang.org/x/sys v0.45.0 // indirect
golang.org/x/term v0.43.0 // indirect
golang.org/x/text v0.37.0 // indirect
golang.org/x/time v0.14.0 // indirect
golang.org/x/tools v0.44.0 // indirect
golang.org/x/sync v0.21.0 // indirect
golang.org/x/sys v0.46.0 // indirect
golang.org/x/term v0.44.0 // indirect
golang.org/x/text v0.38.0 // indirect
golang.org/x/time v0.15.0 // indirect
golang.org/x/tools v0.45.0 // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20260128011058-8636f8732409 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20260319201613-d00831a3d3e7 // indirect
google.golang.org/grpc v1.79.3 // indirect
Expand All @@ -139,16 +139,14 @@ require (
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/apiserver v0.36.1 // indirect
k8s.io/apiserver v0.36.2 // indirect
k8s.io/component-helpers v0.36.1 // indirect
k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b // indirect
k8s.io/kms v0.36.1 // indirect
k8s.io/kube-openapi v0.0.0-20260317180543-43fb72c5454a // indirect
k8s.io/streaming v0.36.1 // indirect
k8s.io/kms v0.36.2 // indirect
k8s.io/kube-openapi v0.0.0-20260603220949-865597e52e25 // indirect
k8s.io/streaming v0.36.2 // indirect
sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.34.0 // indirect
sigs.k8s.io/json v0.0.0-20250730193827-2d320260d730 // indirect
sigs.k8s.io/kube-storage-version-migrator v0.0.6-0.20230721195810-5c8923c5ff96 // indirect
sigs.k8s.io/randfill v1.0.0 // indirect
)

replace github.com/openshift/library-go => github.com/jubittajohn/library-go v0.0.0-20260529005742-3c9df83aa03b
Loading