Reconcile the two documented forms of the release command - #9
Merged
Conversation
The verification loop said `make-release.sh` "takes no arguments" while
the Deploying section below it passes a deploy root and a version. Read
together those contradict, and the first is only true because the local
loop sources `secrets/.env` a few lines earlier.
Both forms are correct and the document never said why. It now states the
mechanism: the deploy root falls back to `$DEPLOY_ROOT` and the version
to a timestamp, the script accepts both regardless, and an argument wins
over the environment. It also says why CI passes them explicitly, which
is so a pipeline run names the commit it built rather than the clock.
Verified against the script rather than asserted:
ROOT="${1:-${DEPLOY_ROOT:-}}"
VERSION="${2:-$(date -u +%Y%m%d-%H%M%S)}"
Raised as a suppressed comment on the promotion, which carries no thread.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates OPERATIONS.md to reconcile the two documented invocation styles for deploy/make-release.sh by explicitly documenting its argument/env-var fallback behavior and why CI/pipelines pass arguments explicitly (stable, commit-derived naming vs timestamp defaults).
Changes:
- Clarifies that
deploy/make-release.shcan be run with no arguments whenDEPLOY_ROOTis available, and that the version defaults to a UTC timestamp. - Documents precedence: provided arguments override environment-derived defaults.
- Explains why automated runs pass both deploy root and version explicitly (traceability to the built commit).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The verification loop said
make-release.sh"takes no arguments" while the Deploying section below it passes a deploy root and a version. Read together those contradict, and the first is only true because the local loop sourcessecrets/.enva few lines earlier.Both forms are correct and the document never said why. It now states the mechanism, verified against the script rather than asserted:
So the deploy root falls back to
$DEPLOY_ROOT, the version falls back to a timestamp, the script accepts both regardless, and an argument wins over the environment. It also now says why CI passes them explicitly: so a pipeline run names the commit it built rather than the clock.Raised as a suppressed comment on the promotion #7, which carries no thread, so it is answered there as well.