Skip to content

BREAKING CHANGE: prefix registry user env var with STATICREG_#46

Merged
fntlnz merged 2 commits intomasterfrom
bc/registry-user-env-var
Dec 3, 2025
Merged

BREAKING CHANGE: prefix registry user env var with STATICREG_#46
fntlnz merged 2 commits intomasterfrom
bc/registry-user-env-var

Conversation

@fntlnz
Copy link
Copy Markdown
Contributor

@fntlnz fntlnz commented Dec 3, 2025

No description provided.

@fntlnz fntlnz requested a review from munishchouhan December 3, 2025 18:09
@fntlnz fntlnz force-pushed the bc/registry-user-env-var branch from a636b64 to 9d153b2 Compare December 3, 2025 18:10
@fntlnz fntlnz force-pushed the bc/registry-user-env-var branch from 9d153b2 to aa602da Compare December 3, 2025 18:10
@fntlnz
Copy link
Copy Markdown
Contributor Author

fntlnz commented Dec 3, 2025

@claude

@claude
Copy link
Copy Markdown

claude Bot commented Dec 3, 2025

Claude finished @fntlnz's task —— View job


Code Review: Environment Variable Prefix Breaking Change

Todo List:

  • Read repository guidelines (CLAUDE.md) - no CLAUDE.md found
  • Review each changed file to understand the scope
  • Verify consistency of the environment variable change
  • Check if breaking change is properly documented
  • Provide comprehensive review feedback

Summary

This PR implements a BREAKING CHANGE that adds the STATICREG_ prefix to the REGISTRY_USER environment variable for consistency with other configuration variables. The change affects 5 files and bumps the version from 0.5.2 to 0.6.0.

✅ What's Done Well

Complete and Consistent Implementation

All references to the old REGISTRY_USER environment variable have been properly updated to STATICREG_REGISTRY_USER:

  • Code (cmd/root.go:77) - Environment variable reading updated
  • Documentation (README.md:107, 157) - CLI docs and Kubernetes examples updated
  • Architecture docs (docs/ARCHITECTURE.md:166) - Environment variable list updated
  • Kubernetes manifests (manifests/deployment.yml:42) - Secret key reference updated
  • Version bump (VERSION) - Appropriately bumped to 0.6.0 for breaking change

Proper Breaking Change Handling

  • Semantic versioning: Major version bump (0.5.2 → 0.6.0) correctly signals breaking change
  • Commit message: Properly marked with BREAKING CHANGE: prefix following conventional commits
  • No orphaned references: Verified no old REGISTRY_USER references remain in codebase

Consistency Achievement

This change achieves the stated goal of consistency - all registry-related environment variables now use the STATICREG_ prefix:

  • STATICREG_REGISTRY_HOSTNAME
  • STATICREG_REGISTRY_USER ✅ (newly prefixed)
  • STATICREG_REGISTRY_PASSWORD

📝 Minor Observations

Documentation Coverage

The breaking change is well-documented through:

  • Updated CLI help text with correct environment variable name
  • Updated README examples (both env vars and Kubernetes secrets)
  • Updated architecture documentation

Migration Path

Users upgrading will need to:

  1. Update their environment variable from REGISTRY_USER to STATICREG_REGISTRY_USER
  2. Update Kubernetes secrets to use the new key name
  3. Update any automation/scripts referencing the old variable

This is clearly a runtime breaking change - existing deployments will fail to authenticate until the environment variable is renamed.

✅ Final Assessment

APPROVED - This is a clean, well-executed breaking change that:

  • ✅ Achieves consistency across all environment variables
  • ✅ Updates all relevant files comprehensively
  • ✅ Follows proper semantic versioning practices
  • ✅ Uses conventional commit standards for breaking changes
  • ✅ Updates all documentation and examples

The change is straightforward and the migration path is clear. Users will need to update their environment variable configuration, but this is well-documented and the error will be obvious (authentication failure) if missed.


@fntlnz fntlnz merged commit 73ce39b into master Dec 3, 2025
5 checks passed
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.

1 participant