Skip to content

Rename the Host Env Files to the Fleet's Underscore-Joined Form - #557

Merged
ptr727 merged 2 commits into
developfrom
chore/env-file-underscore-names
Oct 27, 2026
Merged

ptr727 merged 2 commits into
developfrom
chore/env-file-underscore-names

Conversation

@ptr727

@ptr727 ptr727 commented Oct 27, 2026 •

Copy link
Copy Markdown
Owner

Summary

Renames Blog's host env files to the fleet's underscore-joined form, per the env and secret file naming rule #556 carried into CODESTYLE.md from hub f60f57d. That rule reaches a host-side file the repository's docs or scripts name, so blog.<server>.<environment>.env becomes blog_<server>_<environment>.env, with each field unchanged.

  • deploy/make-release.sh: DEFAULT_ENV_FILE is now ~/.secrets/blog_local_production.env, and the --help text and the naming comment match it.
  • Docs: .secrets/README.md, .secrets/example.env, ENVIRONMENT.md, OPERATIONS.md, README.md, capture/README.md, and deploy/README.md name the four files the new way. The tracked template's own name, example.env, already conformed, so only its comments change.

Hostnames such as the VPS staging FQDN are not env files and are unchanged.

Host-Side Step

Each host running make-release.sh renames its files when this merges. On a host holding all four:

cd ~/.secrets
mv blog.local.production.env blog_local_production.env
mv blog.local.staging.env blog_local_staging.env
mv blog.vps.production.env blog_vps_production.env
mv blog.vps.staging.env blog_vps_staging.env

Until a host renames its files, a run that names ENV_FILE is refused because the file is not found. A run that relies on the default reads no file and prints no ==> environment: line. It then exits at the usage text, or builds against a DEPLOY_ROOT and SITE_BASE_URL the shell already exported, so rename the files before the first run after this merges. The documented set -a; . ~/.secrets/... lines fail on the missing file first. CI reads no env file, so it is unaffected.

Ordering

#553 pairs with this change and lands second, so it reads the new names.

Local Review

One local strict review pass on the frontier tier, recorded. It found no defect in the diff and raised the rollout risk the host-side step above states. The unit suite, env_docs_gate.py, the prose gate, markdownlint, cspell, shellcheck, shfmt, and editorconfig-checker run clean apart from the comment-added lines below.

The comments label is on this PR because the edited make-release.sh comment lines trip the comment-added gate.

🤖 Generated with Claude Code

The carried CODESTYLE.md naming rule reaches a host-side file the
repository's docs or scripts name, so blog.<server>.<environment>.env
becomes blog_<server>_<environment>.env. make-release.sh's default and
every doc naming one of the four files change together.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings October 27, 2026 22:05
@ptr727 ptr727 added the comments Permits the comment lines the pull request adds or edits, which the prose gate otherwise refuses label Oct 27, 2026
@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: f6eea563-6da6-4acb-8c2d-591dc61cf322
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (develop@9ff409a). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop     #557   +/-   ##
==========================================
  Coverage           ?   53.98%           
==========================================
  Files              ?       12           
  Lines              ?     3412           
  Branches           ?        0           
==========================================
  Hits               ?     1842           
  Misses             ?     1570           
  Partials           ?        0           
Flag Coverage Δ
python-3.13 53.98% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The catalog still describes a blog. filename prefix that conflicts with the newly documented underscore-joined naming, which could mislead maintainers.

1 open issue
What changed in this PR

This pull request renames Blog’s host environment files from dot-separated names to the fleet-standard underscore-joined format and updates the release script and documentation accordingly.

Changes:

  • Updates make-release.sh defaults, help text, and naming comments.
  • Renames environment-file references across repository, operations, deployment, and capture documentation.
  • Updates the tracked environment template and secrets catalog.
  • Requires host-side environment files to be renamed before the next release run.
File Summary Review notes
README.md Updates release instructions and environment-file references. —
OPERATIONS.md Renames environment files throughout operational procedures and tables. —
ENVIRONMENT.md Updates the naming convention and default environment path. —
deploy/​README.md Revises deployment setup, examples, and environment-variable documentation. —
deploy/​make-release.sh Uses the underscore-joined default environment file and updated help text. —
capture/​README.md Updates capture setup instructions to use the renamed file. —
.secrets/​README.md Updates the host environment-file catalog and references. Nit, 4 votes: Update the stale description that says the files carry a blog. prefix.
.secrets/​example.env Updates the template’s filename examples to the underscore-joined form. Nit, 1 vote: Reconcile the template scope description with the filename changes in the patch.

Review effort: Lite

Comment thread .secrets/README.md
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Approval should be deferred because automated review cannot verify that every host migrates the four live ~/.secrets files before the new default and documented ENV_FILE paths are used.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Low severity Correct PR description for renamed documented destinations

.secrets/​example.env:7

Update the PR description to match this change. It says the tracked template already conformed, but this hunk changes its documented destinations from dotted names to underscore-joined names, so the summary is inaccurate about a changed file.

1 resolved since last review

Review effort: Lite

@ptr727

ptr727 commented Oct 27, 2026

Copy link
Copy Markdown
Owner Author

Update the PR description to match this change. It says the tracked template already conformed, but this hunk changes its documented destinations from dotted names to underscore-joined names, so the summary is inaccurate about a changed file.

Fixed in the PR description. It now says the template's own name, example.env, already conformed, so only its comments change. The file was already in the changed-files list on the same line.

@ptr727
ptr727 merged commit b885743 into develop Oct 27, 2026
13 checks passed
@ptr727
ptr727 deleted the chore/env-file-underscore-names branch October 27, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comments Permits the comment lines the pull request adds or edits, which the prose gate otherwise refuses

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants