ankane / setup-postgres Goto Github PK

View Code? Open in Web Editor NEW

38.0 4.0 6.0 83 KB

The missing action for Postgres

License: MIT License

JavaScript 100.00%

setup-postgres's Introduction

setup-postgres

The missing action for Postgres 🎉

Faster (with the default version) and simpler than containers
Works on Linux, Mac, and Windows
Supports different versions

Getting Started

Add it as a step to your workflow

      - uses: ankane/setup-postgres@v1

Versions

Specify a version

      - uses: ankane/setup-postgres@v1
        with:
          postgres-version: 16

Currently supports

Version	`16`	`15`	`14`	`13`	`12`	`11`	`10`	`9.6`
Ubuntu	✓	✓	default	✓	✓	✓	✓	✓
Mac	✓	✓	default	✓	✓	✓
Windows			default

Test against multiple versions

    strategy:
      matrix:
        postgres-version: [16, 15, 14, 13, 12]
    steps:
      - uses: ankane/setup-postgres@v1
        with:
          postgres-version: ${{ matrix.postgres-version }}

Options

Create a database

      - uses: ankane/setup-postgres@v1
        with:
          database: testdb

Set postgresql.conf config

      - uses: ankane/setup-postgres@v1
        with:
          config: |
            shared_preload_libraries = 'pg_stat_statements'

Install development files (for building extensions)

      - uses: ankane/setup-postgres@v1
        with:
          dev-files: true

Extra Steps

Run queries

      - run: psql -d testdb -c 'SHOW server_version'

Related Actions

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

Report bugs
Fix bugs and submit pull requests
Write, clarify, or fix documentation
Suggest or add new features

setup-postgres's People

Contributors

Stargazers

Watchers

Forkers

r-dbi dpprdan damncabbage cipherstash florents-tselai

setup-postgres's Issues

Run createdb?

This action runs createuser for the worker's user, should it also run createdb?

If I do this as a user, it looks rather clumsy: https://github.com/r-dbi/RPostgres/blob/master/.github/workflows/R-CMD-check.yaml#L105-L114

Ideas

Add input for postgresql.conf - config: | shared_preload_libraries = 'pg_stat_statements'
Add database and user inputs
Add instructions for caching
Support latest version
Add input for pg_hba.conf - hba: | ... (naming based on file locations)

Postgres 14 available on mac via homebrew

From https://formulae.brew.sh/formula/postgresql I gather that Postgres 14 is available for mac via homebrew. Is it necessary to update https://github.com/ankane/setup-postgres/blob/v1/index.js accordingly?

In any case I am getting the following error when trying the default version (i.e. v13 currently) or v13 explicitly:

/bin/sh: /usr/local/opt/postgresql@13/bin/pg_ctl: No such file or directory

When explicitly requesting postgres-version: 14 it is already installed apparently.

Move to Node 16

GitHub Actions suggests that Node 12 will be deprecated by mid-2023: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. I don't know how much we need to change, but I'm relying on the following actions:

What's the best way to move forward?

Warning: apt-key output should not be parsed

The action throws a warning on Ubuntu:

wget --quiet -O - postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
Warning: apt-key output should not be parsed (stdout is not a terminal)

The warning doesn't show up in the action summary of this repo for some reason, but it does elsewhere, see details.

More info on the warning.

User, password, host, port?

First of all, thank you for this action.

When one wants to connect to the DB created by this action, what's the username, password, host, and port for it? I think this would be useful to include in the documentation. Same for setup-mariadb, setup-mysql, and the other actions.