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
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.4
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
143 changes: 143 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
# =============================================================================
# Tier 1 — Common Pre-Commit Hooks for OSD Operators
# SREP-4485 | Golden rules: SREP-4450
# =============================================================================
#
# INSTALL
# For detailed setup instructions including uv (recommended) and pip,
# see: boilerplate/openshift/golang-osd-operator/docs/pre-commit.md
#
# Quick start (uv):
# uv sync && source .venv/bin/activate && pre-commit install
#
# Quick start (pip):
# pip install 'pre-commit==4.6.0' && 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.
#
# Fix commits can be excluded from git blame
# https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-filefile
#
# =============================================================================

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]
Comment on lines +68 to +69
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.

🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win

Expand manifest hook scope to include deploy_pko/.

Both manifest-oriented hooks currently skip deploy_pko/, so changed deployment manifests there won’t be checked locally.

Suggested patch
       - id: check-yaml
         name: YAML syntax (deploy/)
-        files: ^deploy/.*\.ya?ml$
+        files: ^(deploy|deploy_pko)/.*\.ya?ml$
         args: [--allow-multiple-documents]
@@
       - id: rbac-wildcard-check
         name: RBAC wildcard permissions
         language: system
         entry: bash -c 'make rbac-wildcard-check'
-        files: ^deploy/.*\.ya?ml$
+        files: ^(deploy|deploy_pko)/.*\.ya?ml$
         pass_filenames: false

Also applies to: 140-140

🤖 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 67 - 68, Update the manifest hook
file-matching regex so it also matches deploy_pko manifests: replace occurrences
of the pattern "files: ^deploy/.*\.ya?ml$" (there are two occurrences) with a
regex that includes the deploy_pko directory, e.g. "files:
^deploy(_pko)?/.*\.ya?ml$" or "files: ^(deploy|deploy_pko)/.*\.ya?ml$" so
changed deployment manifests in deploy_pko/ are checked locally.


# ---------------------------------------------------------------------------
# 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
6 changes: 2 additions & 4 deletions OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
# =============================================================================
aliases:
srep-functional-team-aurora:
- abyrne55
- AlexSmithGH
- BATMAN-JD
- dakotalongRH
- eth1030
- geowa4
- joshbranham
- luis-falcon
- reedcort
srep-functional-team-fedramp:
- theautoroboto
Expand Down Expand Up @@ -73,7 +73,6 @@ aliases:
- yiqinzhang
- varunraokadaparthi
srep-functional-leads:
- abyrne55
- clcollins
- bergmannf
- theautoroboto
Expand All @@ -91,5 +90,4 @@ aliases:
- maorfr
- rogbas
srep-architects:
- jharrington22
- cblecker
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.4
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 @@
28f0d527a87f963961e218687f8e481acf62e47d
05d233f4d9639f3e1c54ead5c2b1eb59654091b6
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
6 changes: 2 additions & 4 deletions boilerplate/openshift/golang-osd-operator/OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
# =============================================================================
aliases:
srep-functional-team-aurora:
- abyrne55
- AlexSmithGH
- BATMAN-JD
- dakotalongRH
- eth1030
- geowa4
- joshbranham
- luis-falcon
- reedcort
srep-functional-team-fedramp:
- theautoroboto
Expand Down Expand Up @@ -73,7 +73,6 @@ aliases:
- yiqinzhang
- varunraokadaparthi
srep-functional-leads:
- abyrne55
- clcollins
- bergmannf
- theautoroboto
Expand All @@ -91,5 +90,4 @@ aliases:
- maorfr
- rogbas
srep-architects:
- jharrington22
- cblecker
123 changes: 123 additions & 0 deletions boilerplate/openshift/golang-osd-operator/docs/pre-commit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Pre-Commit Hooks Setup Guide

## Installation

### Recommended: Using uv

[uv](https://github.com/astral-sh/uv) is recommended for Python dependency management. It provides dependency locking with package hashes (supply-chain protection), virtual environment management, and is 10-100x faster than pip.

**Install uv:**
```bash
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

# Via pip
pip install uv
```

**First-time setup:**
```bash
uv init --bare # creates pyproject.toml
uv add --dev pre-commit==4.6.0 # adds dependency, generates uv.lock
source .venv/bin/activate # macOS/Linux (.venv\Scripts\activate on Windows)
pre-commit install
```

**Subsequent setup** (when `pyproject.toml` and `uv.lock` exist):
```bash
uv sync
source .venv/bin/activate
pre-commit install
```

### Alternative: Using pip

```bash
pip install 'pre-commit==4.6.0' # pinned version (Golden Rule 15)
pre-commit install
```

Add to `requirements-dev.txt`: `pre-commit==4.6.0`

## First-Time Setup

Run on all files to catch existing issues:
```bash
pre-commit run --all-files
```

Auto-fix hooks will modify files on first run. Stage and commit these separately:
```bash
git diff
git add .
git commit -m "Fix: Apply pre-commit auto-fixes"
```

**Exclude fix commits from git blame:**
```bash
# Create .git-blame-ignore-revs with commit hashes
git config blame.ignoreRevsFile .git-blame-ignore-revs
```

See [git-blame docs](https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-filefile).

## Usage

**Automatic** (runs on `git commit`):
```bash
git add <files>
git commit -m "Message"
```

**Manual:**
```bash
pre-commit run # staged files only
pre-commit run --all-files # entire repo
pre-commit run --files path/to/file # specific files
```

**Bypass (use sparingly):**
```bash
SKIP=hook-id git commit -m "Message" # skip one hook
git commit --no-verify # NEVER use (Golden Rule 16)
```

Rules: Agents never bypass hooks. Security hooks (gitleaks) never bypassable.

## Troubleshooting

**macOS timeout issues:**
```bash
brew install coreutils # provides gtimeout
```

**Virtual environment not found:**
```bash
source .venv/bin/activate
uv sync
```

**Hooks not running:**
```bash
ls -la .git/hooks/pre-commit # verify installation
pre-commit install # reinstall
```

**Hook failures:** Read error messages and fix issues:
- `go-build`: Fix compilation errors
- `go-mod-tidy`: Run `go mod tidy` and stage go.mod/go.sum
- `check-yaml`: Fix YAML syntax

## CI Integration

Pre-commit mirrors `ci/prow/lint`. CI is authoritative; pre-commit is developer convenience. All hooks run in CI with same config.

If pre-commit passes but CI fails: `pre-commit autoupdate`

## Resources

- [Pre-Commit Documentation](https://pre-commit.com/)
- [uv Documentation](https://github.com/astral-sh/uv)
Loading