Skip to content

fix(docs): prevent masked pg_dump failures #5451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abdlrhmn0x7e wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(docs): prevent masked pg_dump failures #5451

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c222986
fix(docs): harden S3 backup workflow example
abdlrhmn0x7e Aug 5, 2026
ed3b3ef
docs: remove unnecessary shell quoting explanation
abdlrhmn0x7e Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions content/docs/manage/backups-aws-s3-backup-part-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ jobs:

- name: Run pg_dump
run: |
$POSTGRES/pg_dump ${{ env.DATABASE_URL }} | gzip > "${{ env.GZIP_NAME }}"
set -o pipefail
: "${DATABASE_URL:?DATABASE_URL secret is not set}"
"${POSTGRES}/pg_dump" "$DATABASE_URL" | gzip > "$GZIP_NAME"

- name: Empty bucket of old files
run: |
Expand Down Expand Up @@ -255,9 +257,13 @@ This step runs `pg_dump` and saves the output in the Action's virtual memory usi
```yml
- name: Run pg_dump
run: |
$POSTGRES/$pg_dump ${{ env.DATABASE_URL }} | gzip > "${{ env.GZIP_NAME }}"
set -o pipefail
: "${DATABASE_URL:?DATABASE_URL secret is not set}"
"${POSTGRES}/pg_dump" "$DATABASE_URL" | gzip > "$GZIP_NAME"
```

Enabling `pipefail` ensures the workflow fails when `pg_dump` fails instead of reporting success because `gzip` completed.

## Empty bucket of old files

This optional step automatically removes `.gz` files older than the retention period specified by the `RETENTION` variable. It checks the `FOLDER_NAME` directory and deletes outdated backups to save storage space.
Expand Down