Back

Code quality

Config Cleanup: Remove Old Environment Modes and Flags

Config cleanup is risky because old modes and flags often encode deployment history. A variable can look stale in the current service while still controlling a rollback path, regional override, migration mode, test environment, or older release branch.

The useful output is a config cleanup pull request with read-path evidence, deployment diff, behavior decision, validation check, and rollback notes. Keep the review concrete: Remove config reads and deployment values in the same reviewed change, then make the next action visible to the team that owns the risk. That matters because the cleanup can still go wrong when removing config that still supports a deployment target.

Key takeaways

  • Treat each cleanup candidate as an owned system with dependencies, not anonymous clutter.
  • Use one release cycle plus any rollback, migration, and regional deployment window before deciding that “quiet” means “unused.”
  • Prefer reversible changes first when removing config that still supports a deployment target is still plausible.
  • Leave behind a config cleanup pull request with read-path evidence, deployment diff, behavior decision, validation check, and rollback notes so the next review starts with context.
  • Measure the result as lower spend, lower risk, less operational drag, or clearer ownership.

Map Config Read Paths

Start with one service or deployment family where environment variables, config files, feature flags, manifests, secrets, docs, and release branches can be reviewed together. The best cleanup scope is small enough that owners can answer quickly but wide enough to include the attachments that make removal risky.

FieldWhy it matters
OwnerCleanup needs a person or team that can accept the decision
Current purposeA short reason to keep the item, written in present tense
Last meaningful useowners, callers, last change, runtime behavior, and deletion confidence
Dependency evidencerepository search, tests, logs, deploy history, and owner review
Risk if wrongThe outage, data loss, access failure, or rollback gap the review must avoid
Next actionKeep, reduce, archive, disable, remove, or investigate

Do not make the inventory larger than the decision. A short list with owners and evidence beats a perfect spreadsheet that nobody is willing to act on.

Config Evidence to Collect

The useful question is not “how old is it?” It is “what would break, become harder to recover, or lose accountability if this disappeared?” For config cleanup, collect enough evidence to answer that without relying on naming conventions.

CheckWhat to look forCleanup signal
Read pathsCode reads, config schemas, defaults, validation, dynamic lookup, and generated clientsNo supported runtime reads the key or mode
Deployment surfaceCI variables, Kubernetes manifests, Terraform, platform settings, local examples, and secrets storesNo environment still sets the config
Behavior roleRollback mode, migration switch, regional override, customer entitlement, or test-only pathThe behavior is no longer supported or has a replacement
Failure visibilityStartup validation, logs, metrics, alerts, and canary checksRemoving the config will fail visibly if a consumer remains

Use several signals together. Activity can miss monthly jobs and incident-only paths. Ownership can be stale. Cost can distract from security or recovery risk. The strongest case combines runtime data, dependency checks, owner review, and a rollback plan.

If the evidence conflicts, label the item “investigate” with a named owner and review date. That is still progress because the next review starts with a narrower question.

Example Evidence Check

Search both read paths and deployment values so a key is not removed from only one side.

rg "${CONFIG_KEY}|process\.env|import\.meta\.env|getenv" src tests scripts
rg "${CONFIG_KEY}" .github deploy infra docker-compose*.yml README* docs
rg "${CONFIG_KEY}" .env.example config secrets.example

Treat the output as a candidate list. Do not pipe these checks into delete commands; add owner review, dependency checks, and a rollback path first.

Remove Reads and Values Together

Use the least permanent move that proves the decision. In config cleanup, removal is only one possible outcome; reducing size, narrowing permission, shortening retention, archiving, or disabling a trigger may produce the same benefit with less risk.

  • Remove config reads and deployment values in the same reviewed change.
  • Add startup validation or warnings before deleting keys with uncertain consumers.
  • Clean docs, examples, dashboards, and runbooks so the stale mode is not reintroduced.

Track the cleanup candidate with a simple priority score:

ScoreGood signBad sign
ImpactMeaningful spend, risk, toil, noise, or confusion disappearsThe item is cheap and low-risk but politically distracting
ConfidenceOwner, purpose, and dependency path are understoodThe team is guessing from age or name
ReversibilityRestore, recreate, re-enable, or rollback path existsDeletion would be the first real test
PreventionA rule can stop recurrenceThe same pattern will return next month

Start with high-impact, high-confidence, reversible candidates. Defer confusing items only if they get an owner and a date; otherwise “defer” becomes another word for keeping waste permanently.

Modes That Still Protect Releases

Some cleanup candidates are supposed to look quiet. Do not rush these cases:

  • Rollback switches, regional overrides, migration modes, and customer-specific behavior.
  • Config read dynamically by libraries, plugins, or older release branches.
  • Variables copied into local examples, CI contexts, or secret stores outside the main repository.

For these cases, use a longer observation window, explicit owner approval, and a staged reduction. The point is not to avoid cleanup; it is to avoid making the first proof of dependency an outage.

Run the Config Cleanup PR

Run config cleanup as a decision review, not an open-ended hygiene project.

  1. Pick the narrow scope and export the candidate list.
  2. Add owner, current purpose, last-use evidence, dependency checks, and risk if wrong.
  3. Remove obvious false positives, then ask owners to choose keep, reduce, archive, disable, remove, or investigate.
  4. Apply the least permanent useful change first.
  5. Watch the signals that would reveal a bad decision.
  6. Complete the final removal only after the review window closes.
  7. Save a config cleanup pull request with read-path evidence, deployment diff, behavior decision, validation check, and rollback notes.

For broader cleanup planning, use the cleanup library to pair this guide with related notes. If the cleanup has infrastructure impact, pair it with a visible owner, a rollback path, and a measurable business case. For infrastructure cleanup, the main cloud cost optimization checklist is a useful companion.

Create Config With Expiry

Prevention should change the creation path, not just the cleanup path. For config cleanup, the useful prevention fields are owner, reason to exist, removal trigger, and verification notes. Make those fields part of normal creation and review.

  • Create config through typed schemas with owner, purpose, and removal trigger.
  • Fail builds or startup checks for undocumented long-lived environment variables.
  • Review config keys when feature flags, migrations, and deployment targets are retired.

The recurring review should be short: sort by impact, pick the unclear items, assign owners, and close the loop on anything nobody claims. If the review keeps producing the same class of candidate, fix the creation path instead of celebrating repeated cleanup.

Example Decision Record

Use a compact record so the cleanup can be reviewed later without reconstructing the whole investigation.

FieldExample entry for this cleanup
CandidateStale configuration in applications
Why it looked staleLow recent activity, unclear owner, or no current consumer after the first review
Evidence checkedRead paths, Deployment surface, and owner confirmation
First reversible moveRemove config reads and deployment values in the same reviewed change
Watch signalThe metric, alert, job, route, query, or owner complaint that would show the cleanup was wrong
Final actionKeep, reduce, archive, disable, or remove after one release cycle plus any rollback, migration, and regional deployment window
Prevention ruleCreate config through typed schemas with owner, purpose, and removal trigger

This record is intentionally small. If the decision needs a long narrative, the candidate is probably not ready for removal yet. Keep investigating until the owner, evidence, reversible move, and prevention rule are clear.

FAQ

How often should teams do config cleanup?

Use one release cycle plus any rollback, migration, and regional deployment window for the first decision, then set a recurring cadence based on change rate. Fast-moving non-production systems may need monthly review; slower systems can be quarterly if every unclear item has an owner and a review date.

What is the safest first action?

The safest first action is usually ownership repair plus evidence collection. After that, remove config reads and deployment values in the same reviewed change. That creates a visible test before permanent deletion.

What should not be removed quickly?

Do not rush anything connected to rollback switches, regional overrides, migration modes, and customer-specific behavior. Also slow down when the cleanup affects recovery, compliance, customer-specific behavior, rare schedules, or security response.

How do you make the decision useful later?

Write the decision as a small operational record: candidate, owner, evidence, chosen action, watch signals, rollback path, final date, and prevention rule. That format helps future engineers, search engines, and AI assistants understand the cleanup without guessing.