Repository navigation
docs: semi-technical copy for storage / delivery messaging - #73
Conversation
- Landing live flow and storage stat speak to builders in plain language - Architecture diagram bullet aligned with README Mermaid and step copy
There was a problem hiding this comment.
Pull request overview
Updates customer-facing messaging to be more outcome-focused (replacing “durable queue” phrasing), and adds an automation workflow intended to provision per-PR Neon database branches.
Changes:
- Adjust landing page copy to describe storage as “saved safely until delivery / safe until delivery.”
- Update architecture diagram and README diagram/steps to reflect the new storage wording.
- Add a GitHub Actions workflow to create/delete Neon branches for pull requests and run DB migrations.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
components/app/architecture-diagram.tsx |
Rewords the clawproxy “storage” bullet to “Saves events until delivery.” |
app/page.tsx |
Updates “Ingress accepted” and “Storage” labels to outcome-focused language. |
README.md |
Rewords Mermaid diagram + step 2 to “Safe storage” / “stores safely until node connects.” |
.github/workflows/neon_workflow.yml |
Adds PR lifecycle workflow for Neon branch creation/deletion and migrations. |
| db_url: ${{ steps.create_neon_branch_encode.outputs.db_url }} | ||
| db_url_with_pooler: ${{ steps.create_neon_branch_encode.outputs.db_url_with_pooler }} |
There was a problem hiding this comment.
create_neon_branch job outputs reference steps.create_neon_branch_encode.*, but there is no step with id create_neon_branch_encode in this job (the step id is create_neon_branch). As written, these job outputs will always be empty/unset; update the references (or add the missing step) so outputs resolve correctly.
| db_url: ${{ steps.create_neon_branch_encode.outputs.db_url }} | |
| db_url_with_pooler: ${{ steps.create_neon_branch_encode.outputs.db_url_with_pooler }} | |
| db_url: ${{ steps.create_neon_branch.outputs.db_url }} | |
| db_url_with_pooler: ${{ steps.create_neon_branch.outputs.db_url_with_pooler }} |
| steps: | ||
| - name: Get branch expiration date as an env variable (2 weeks from now) | ||
| id: get_expiration_date | ||
| run: echo "EXPIRES_AT=$(date -u --date '+14 days' +'%Y-%m-%dT%H:%M:%SZ')" >> "$GITHUB_ENV" | ||
| - name: Create Neon Branch | ||
| id: create_neon_branch | ||
| uses: neondatabase/create-branch-action@v6 | ||
| with: | ||
| project_id: ${{ vars.NEON_PROJECT_ID }} | ||
| branch_name: preview/pr-${{ github.event.number }}-${{ needs.setup.outputs.branch }} | ||
| api_key: ${{ secrets.NEON_API_KEY }} | ||
| expires_at: ${{ env.EXPIRES_AT }} | ||
|
|
||
| # The step above creates a new Neon branch. | ||
| # You may want to do something with the new branch, such as run migrations, run tests | ||
| # on it, or send the connection details to a hosting platform environment. | ||
| # The branch DATABASE_URL is available to you via: | ||
| # "${{ steps.create_neon_branch.outputs.db_url_with_pooler }}". | ||
| # It's important you don't log the DATABASE_URL as output as it contains a username and | ||
| # password for your database. | ||
| # For example, you can uncomment the lines below to run a database migration command: | ||
| - name: Run Migrations | ||
| run: npm run db:migrate | ||
| env: | ||
| # to use pooled connection | ||
| #DATABASE_URL: "${{ steps.create_neon_branch.outputs.db_url_with_pooler }}" | ||
| # OR to use unpooled connection | ||
| DATABASE_URL: "${{ steps.create_neon_branch.outputs.db_url }}" | ||
|
|
There was a problem hiding this comment.
The Run Migrations step runs npm run db:migrate but this job never checks out the repo or installs dependencies / sets up Node. On a fresh runner this will fail because package.json (and node_modules) won't be present. Add actions/checkout, actions/setup-node + Corepack, install deps (e.g. yarn install --immutable), then run the migrate script (prefer yarn db:migrate to match the repo CI workflow).
| name: Create/Delete Branch for Pull Request | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: | ||
| - opened | ||
| - reopened | ||
| - synchronize | ||
| - closed | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} |
There was a problem hiding this comment.
This PR is described as documentation/copy updates, but it also adds a new GitHub Actions workflow that creates/deletes Neon branches and runs migrations. Please update the PR description/title to include this operational change (or split the workflow into a separate PR) so reviewers can assess the workflow/security implications explicitly.
Replaces customer-facing “durable queue” wording with plain, outcome-focused language aimed at semi-technical readers.
Changes
app/page.tsx): live-flow step and Storage stat use “validated and saved safely…” and “Safe until delivery.”components/app/architecture-diagram.tsx): clawproxy bullet “Saves events until delivery.”README.md): Mermaid node “Safe storage”; step 2 stores events safely until the node connects.Verification
yarn lintyarn test:run(223 tests)yarn build