Repository navigation
docs: add missing alert webhook and keeper TTL vars to .env.example - #1149
Conversation
|
@rajesetavie-maker Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
@rajesetavie-maker is attempting to deploy a commit to the Collins' projects Team on Vercel. A member of the Team first needs to authorize it. |
collinsezedike
left a comment
There was a problem hiding this comment.
The two added variables are real and needed. Three lines have typos, and the commit header is 73 characters (the repo limit is 72). Details inline.
| # immediately; DeFindex needs a second, time-separated share-price sample | ||
| # per pool before it can report a rate, persisted via UPSTASH_REDIS_REST_URL | ||
| # / UPSTASH_REDIS_REST_TOKEN above (falls back to an in-memory, per-process | ||
| # per pool before it can report a rate, persisted via UPSTASh_REDIS_REST_URL |
There was a problem hiding this comment.
UPSTASH_REDIS_REST_URL is misspelled here as UPSTASh_REDIS_REST_URL (lowercase h). CI will not catch this, but anyone copying this file would set the wrong name.
| # per pool before it can report a rate, persisted via UPSTASH_REDIS_REST_URL | ||
| # / UPSTASH_REDIS_REST_TOKEN above (falls back to an in-memory, per-process | ||
| # per pool before it can report a rate, persisted via UPSTASh_REDIS_REST_URL | ||
| # / UPSTASh_REDIS_REST_TOKEN above (falls back to an in-memory, per-process |
There was a problem hiding this comment.
Same typo on the token name: UPSTASh_REDIS_REST_TOKEN should be UPSTASH_REDIS_REST_TOKEN.
| # set). The live testnet vault still doesn't have migrate_adapter deployed | ||
| # (see apps/docs/operations/migration-keeper.md, #514), so the keeper can't | ||
| # actually migrate anything on testnet yet regardless of these. | ||
| # actually migrate anything on testnet yeu regardless of these. |
There was a problem hiding this comment.
yeu should be yet.
| UPSTASH_REDIS_REST_URL= | ||
| UPSTASH_REDIS_REST_TOKEN= | ||
| # Fastify API server uses the Redis protocol (ioredis). Format: rediss://default:TOKEN@HOST:PORT | ||
| MERIDIAN_KEEPER_SUBMISSION_TTL_MS=360000 |
There was a problem hiding this comment.
This lands between the Fastify Redis comment and REDIS_URL=, so the comment no longer describes the variable under it. Move MERIDIAN_KEEPER_SUBMISSION_TTL_MS below REDIS_URL= or give it its own comment.
collinsezedike
left a comment
There was a problem hiding this comment.
@rajesetavie-maker the two added variables are correct. Three issues remain: UPSTASh is misspelled twice, the new testnet paragraph contradicts the paragraph below it, and the first commit header is 73 characters so Commit Messages fails. See the inline notes.
| # immediately; DeFindex needs a second, time-separated share-price sample | ||
| # per pool before it can report a rate, persisted via UPSTASH_REDIS_REST_URL | ||
| # / UPSTASH_REDIS_REST_TOKEN above (falls back to an in-memory, per-process | ||
| # per pool before it can report a rate, persisted via UPSTASh_REDIS_REST_URL |
There was a problem hiding this comment.
UPSTASh_REDIS_REST_URL should be UPSTASH_REDIS_REST_URL.
| # per pool before it can report a rate, persisted via UPSTASH_REDIS_REST_URL | ||
| # / UPSTASH_REDIS_REST_TOKEN above (falls back to an in-memory, per-process | ||
| # per pool before it can report a rate, persisted via UPSTASh_REDIS_REST_URL | ||
| # / UPSTASh_REDIS_REST_TOKEN above (falls back to an in-memory, per-process |
There was a problem hiding this comment.
UPSTASh_REDIS_REST_TOKEN should be UPSTASH_REDIS_REST_TOKEN.
| # per pool before it can report a rate, persisted via UPSTASh_REDIS_REST_URL | ||
| # / UPSTASh_REDIS_REST_TOKEN above (falls back to an in-memory, per-process | ||
| # store — not durable across serverless invocations — when those aren't | ||
| # set). The live testnet vault still doesn't have migrate_adapter deployed |
There was a problem hiding this comment.
This paragraph says the testnet vault still lacks migrate_adapter, but the paragraph below says it was redeployed with migrate_adapter present. Delete this stale paragraph and keep the current one.
| # store — not durable across serverless invocations — when those aren't | ||
| # set). The live testnet vault still doesn't have migrate_adapter deployed | ||
| # (see apps/docs/operations/migration-keeper.md, #514), so the keeper can't | ||
| # actually migrate anything on testnet yeu regardless of these. |
There was a problem hiding this comment.
yeu should be yet.
b181272 to
b590162
Compare
collinsezedike
left a comment
There was a problem hiding this comment.
@rajesetavie-maker The obfuscated payload has been removed. The two variable names are correct. Three issues remain. The prose at lines 45 and 46 still says UPSTASh. The testnet paragraphs at lines 48 and 51 contradict each other. yeu at line 50 should be yet.
a75d8ba to
5788d90
Compare
collinsezedike
left a comment
There was a problem hiding this comment.
@rajesetavie-maker Thank you for your contribution. If you are interested, there are more open issues to pick up.
|
@rajesetavie-maker Thank you for your contribution. If you found Meridian useful, please star the repository: https://github.com/drydocs/meridian. |
|
Thank you for the opportunity. I’d be in picking up more open issues. |
Overview
This PR updates
.env.exampleso the setup template contributors copy first matches the configuration surface documented inapps/docs/operations/environment-variables.md. It adds the two missing variables —MERIDIAN_ALERT_WEBHOOK_URLandMERIDIAN_KEEPER_SUBMISSION_TTL_MS— each with a short comment matching the surrounding entries.Related Issue
Changes
📄 Environment Template
.env.exampleMERIDIAN_ALERT_WEBHOOK_URLwith a comment noting it is required by the alert keeper (perenvironment-variables.md:31).MERIDIAN_KEEPER_SUBMISSION_TTL_MSwith a comment noting the documented default of360000(perenvironment-variables.md:26).Verification Results
.env.examplelists every variable documented inenvironment-variables.md, or explicitly notes intentional omissionsCloses #1109