pg-dump/README.md

pg-dump

Run pg_dump to generate a backup

Usage

Using the default PostgreSQL installed on the runner

...
    steps:
      - uses: actions/checkout@v2
      - name: Postgres Dump Backup
        uses: tj-actions/pg-dump@v3
        with:
          database_url: "postgres://test_user:test_user_password@localhost:5432/testdb"
          path: "backups/backup.sql" 
          options: "-O"   

Using a different PostgreSQL version

...
    steps:
      - uses: actions/checkout@v2
      - name: Postgres Dump Backup
        uses: tj-actions/pg-dump@v3
        with:
          database_url: "postgres://test_user:test_user_password@localhost:5432/testdb"
          postgresql_version: "15"  # Note: Only the major version is required e.g. 12, 14, 15
          path: "backups/backup.sql" 
          options: "-O"   

If you feel generous and want to show some extra appreciation:

Support this project with a ⭐

Inputs

INPUT	TYPE	REQUIRED	DEFAULT	DESCRIPTION
database_url	string	true		Database URL
options	string	true	"-O"	Extra options passed to pg_dump
path	string	true		Backup file output location
postgresql_version	string	false		Version of PostgreSQL. e.g 15

• Free software: MIT license

Credits

This package was created with Cookiecutter.

Report Bugs

Report bugs at https://github.com/tj-actions/pg-dump/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your workflow that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.