Skip to content
Open
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .ci-operator.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
build_root_image:
name: boilerplate
namespace: openshift
tag: image-v8.3.5
tag: image-v8.3.6
10 changes: 8 additions & 2 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,14 @@ coverage:
range: "20...100"

status:
project: no
patch: no
project:
default:
target: 35%
threshold: 1%
patch:
default:
target: 50%
threshold: 1%
changes: no

parsers:
Expand Down
134 changes: 134 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# =============================================================================
# Tier 1 — Common Pre-Commit Hooks for OSD Operators
# SREP-4485 | Golden rules: SREP-4450
# =============================================================================
#
# INSTALL
# pip install pre-commit
# pre-commit install
#
# USAGE
# pre-commit run # staged files only (developer / agent workflow)
# pre-commit run --all-files # full repo (CI / first-time setup)
#
# BYPASS (golden rule 16)
# Skip one hook: SKIP=hook-id git commit
# Never use: git commit --no-verify
# Agents: never bypass any hook
# Security hooks: never bypassable under any circumstances
#
# CI RELATIONSHIP (golden rule 17)
# These hooks mirror ci/prow/lint. CI remains the authoritative gate.
# Every check here also runs in CI. Pre-commit is developer convenience.
#
# AGENT USAGE (golden rule 1, 7, 19)
# Agents run: pre-commit run
# Output: PRE_COMMIT=1 is set automatically — hooks emit structured output
# Retry: max 2 fix-and-retry iterations before escalating to human
#
# TIMING TARGETS (golden rule 2, 3)
# Total run: <= 10s target / <= 60s hard limit on a 10-file changeset
# Hooks run fastest-first (golden rule 13). Each hook has a timeout guard.
#
# FIRST RUN NOTE
# Auto-fix hooks (trailing-whitespace, end-of-file-fixer) will correct
# pre-existing violations on the first run. Stage and commit those fixes
# separately before day-to-day use.
#
# =============================================================================

repos:

# ---------------------------------------------------------------------------
# 1. FILE HYGIENE + YAML SYNTAX | target < 2s | auto-fix + error
# - check-merge-conflict: detects unresolved merge markers
# - trailing-whitespace: removes trailing spaces (auto-fix)
# - end-of-file-fixer: ensures single EOF newline (auto-fix)
# - check-yaml: validates YAML syntax in deploy/ manifests;
# mirrors ci/prow/lint: olm-deploy-yaml-validate
# ---------------------------------------------------------------------------
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0 # pinned immutable tag
hooks:
- id: check-merge-conflict
- id: trailing-whitespace
args: [--markdown-linebreak-ext=md]
- id: end-of-file-fixer
- id: check-yaml
name: YAML syntax (deploy/)
files: ^deploy/.*\.ya?ml$
args: [--allow-multiple-documents]

# ---------------------------------------------------------------------------
# 2. SECRETS DETECTION | target < 5s | always blocking
# Scans all file types (YAML, shell, config) — gosec covers Go only.
# High-confidence findings block; configure .gitleaks.toml for allowlist.
# ---------------------------------------------------------------------------
- repo: https://github.com/gitleaks/gitleaks
rev: v8.18.0 # pinned immutable tag (golden rule 15)
hooks:
- id: gitleaks

# ---------------------------------------------------------------------------
# 3. STATIC ANALYSIS | target < 15s cached | error
# Mirrors ci/prow/lint: go-check exactly (same version + config as CI).
# Linter config: boilerplate/openshift/golang-osd-operator/golangci.yml
# ---------------------------------------------------------------------------
- repo: https://github.com/golangci/golangci-lint
rev: v2.0.2 # pinned immutable tag — must match CI (golden rule 15)
hooks:
- id: golangci-lint
args:
- --config=boilerplate/openshift/golang-osd-operator/golangci.yml
- --timeout=120s # graceful timeout (golden rule 3)

# ---------------------------------------------------------------------------
# Local hooks — compile, dependency, security
#
# TIMEOUT NOTE (golden rule 3)
# Uses portable timeout detection: 'timeout' on Linux, 'gtimeout' on macOS.
# macOS: brew install coreutils
# Linux: timeout is available by default (GNU coreutils)
# ---------------------------------------------------------------------------
- repo: local
hooks:

# -----------------------------------------------------------------------
# 4. COMPILE CHECK | target < 10s cached | error
# Catches import cycles and type errors before golangci-lint runs.
# Note: go build ./... writes no binary to the repo (compile check only).
# Fix: resolve compilation errors reported by go build.
# -----------------------------------------------------------------------
- id: go-build
name: go build
language: system
entry: bash -c 'T=$(command -v timeout || command -v gtimeout || echo); ${T:+$T 30s} go build ./...'
types: [go]
pass_filenames: false

# -----------------------------------------------------------------------
# 5. DEPENDENCY DRIFT | target < 10s | error
# Detects uncommitted go.mod/go.sum changes after go mod tidy.
# Fix: run 'go mod tidy' and stage go.mod and go.sum.
# -----------------------------------------------------------------------
- id: go-mod-tidy
name: go mod tidy
language: system
entry: bash -c 'T=$(command -v timeout || command -v gtimeout || echo); ${T:+$T 60s} go mod tidy && git diff --exit-code go.mod go.sum'
files: '(\.go$|go\.(mod|sum)$)'
exclude: '^vendor/'
pass_filenames: false

# -----------------------------------------------------------------------
# 6. RBAC WILDCARD CHECK | target < 5s | warn-only (blocking after cleanup)
# Rejects wildcard RBAC in deploy/ manifests (verbs/resources: ["*"]
# or multi-line - '*' format). Logic lives in standard.mk target
# 'rbac-wildcard-check' for readability and reuse.
# Fix: replace wildcards with explicit verbs and resource names.
# -----------------------------------------------------------------------
- id: rbac-wildcard-check
name: RBAC wildcard permissions
language: system
entry: bash -c 'make rbac-wildcard-check'
files: ^deploy/.*\.ya?ml$
pass_filenames: false
Comment on lines +123 to +134
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

rbac-wildcard-check is blocking despite “warn-only” label.

The current hook will fail commits on non-zero exit, so it is not warn-only as described. Please align the comment (or the hook behavior) to avoid confusion.

Suggested minimal fix (docs aligned to actual behavior)
-      # 6. RBAC WILDCARD CHECK  |  target < 5s  |  warn-only (blocking after cleanup)
+      # 6. RBAC WILDCARD CHECK  |  target < 5s  |  blocking
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# 6. RBAC WILDCARD CHECK | target < 5s | warn-only (blocking after cleanup)
# Rejects wildcard RBAC in deploy/ manifests (verbs/resources: ["*"]
# or multi-line - '*' format). Logic lives in standard.mk target
# 'rbac-wildcard-check' for readability and reuse.
# Fix: replace wildcards with explicit verbs and resource names.
# -----------------------------------------------------------------------
- id: rbac-wildcard-check
name: RBAC wildcard permissions
language: system
entry: bash -c 'make rbac-wildcard-check'
files: ^deploy/.*\.ya?ml$
pass_filenames: false
# 6. RBAC WILDCARD CHECK | target < 5s | blocking
# Rejects wildcard RBAC in deploy/ manifests (verbs/resources: ["*"]
# or multi-line - '*' format). Logic lives in standard.mk target
# 'rbac-wildcard-check' for readability and reuse.
# Fix: replace wildcards with explicit verbs and resource names.
# -----------------------------------------------------------------------
- id: rbac-wildcard-check
name: RBAC wildcard permissions
language: system
entry: bash -c 'make rbac-wildcard-check'
files: ^deploy/.*\.ya?ml$
pass_filenames: false
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.pre-commit-config.yaml around lines 123 - 134, The hook named
"rbac-wildcard-check" currently runs the command specified in entry ("make
rbac-wildcard-check") which will cause pre-commit to fail on non-zero exit, so
either update the comment to state that this hook is blocking (remove
"warn-only") or change the hook to be non-blocking by altering the entry to
swallow failures (e.g., keep "entry" referencing the same make target but ensure
it returns success by appending a no-fail wrapper around "make
rbac-wildcard-check"); reference the id "rbac-wildcard-check" and the entry
command "make rbac-wildcard-check" when making the change.

2 changes: 0 additions & 2 deletions OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# =============================================================================
aliases:
srep-functional-team-aurora:
- abyrne55
- AlexSmithGH
- dakotalongRH
- eth1030
Expand Down Expand Up @@ -73,7 +72,6 @@ aliases:
- yiqinzhang
- varunraokadaparthi
srep-functional-leads:
- abyrne55
- clcollins
- bergmannf
- theautoroboto
Expand Down
2 changes: 1 addition & 1 deletion boilerplate/_data/backing-image-tag
Original file line number Diff line number Diff line change
@@ -1 +1 @@
image-v8.3.5
image-v8.3.6
2 changes: 1 addition & 1 deletion boilerplate/_data/last-boilerplate-commit
Original file line number Diff line number Diff line change
@@ -1 +1 @@
294b1978042a939fb940bc8ae89e498991a7ca43
61dbfdfcfd8ab11f8ccbd58bf1d299c2fa3336dd
10 changes: 8 additions & 2 deletions boilerplate/openshift/golang-osd-operator/.codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,14 @@ coverage:
range: "20...100"

status:
project: no
patch: no
project:
default:
target: 35%
threshold: 1%
patch:
default:
target: 50%
threshold: 1%
changes: no

parsers:
Expand Down
2 changes: 0 additions & 2 deletions boilerplate/openshift/golang-osd-operator/OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# =============================================================================
aliases:
srep-functional-team-aurora:
- abyrne55
- AlexSmithGH
- dakotalongRH
- eth1030
Expand Down Expand Up @@ -73,7 +72,6 @@ aliases:
- yiqinzhang
- varunraokadaparthi
srep-functional-leads:
- abyrne55
- clcollins
- bergmannf
- theautoroboto
Expand Down
85 changes: 61 additions & 24 deletions boilerplate/openshift/golang-osd-operator/golangci.yml
Original file line number Diff line number Diff line change
@@ -1,39 +1,76 @@
version: "2"
run:
concurrency: 10

linters:
default: none
enable:
# Error Handling & Security
- errcheck
- gosec
- govet
- ineffassign
- misspell
- staticcheck
- gosec
- bodyclose
- sqlclosecheck
- contextcheck
- noctx

# Error Prevention
- errorlint
- nilerr
- nilnil
- revive

# Code Quality
- ineffassign
- unconvert
- unparam
- unused
- misspell

# Maintainability
- prealloc
- nolintlint
- gocyclo
- exhaustive
- makezero
- containedctx

settings:
revive:
rules:
- name: package-comments
disabled: true

errcheck:
check-type-assertions: true
check-blank: false

exclusions:
presets:
- std-error-handling

gocyclo:
min-complexity: 15

errorlint:
errorf: true
asserts: true
comparison: true

misspell:
extra-words:
- typo: openshit
correction: OpenShift
exclusions:
generated: lax
presets:
- comments
- common-false-positives
- legacy
- std-error-handling
paths:
- third_party/
- builtin/
- examples/

run:
timeout: 5m
# Incremental linting (new-from-rev) is passed via the Makefile's
# go-check target. In CI it uses PULL_BASE_SHA (guaranteed to exist
# even in shallow clones); locally it falls back to origin/HEAD.

formatters:
enable:
- gofmt
- goimports

issues:
max-issues-per-linter: 0
max-same-issues: 0
formatters:
exclusions:
generated: lax
paths:
- third_party/
- builtin/
- examples/
Loading