Skip to content

Dbmate action

Actions
Run Dbmate database migration tool
v1.15
Latest
By dwin
Star (2)

dbmate-action

This repository contains a GitHub Action for running Dbmate, used for database migrations.

It is based on the official Github Docker image, which is based on Alpine Linux.

Inputs

command

The command to run. Default "--help", but you'll likely want to use "up".

See Dbmate documentation for commands.

Example usage

See https://github.com/amacneil/dbmate#command-line-options for more configuration options to be passed by environment variables.

Basic Usage

Uses the default command up and does not check in the database schema.

...
steps:
  - name: "Run migrations"
    uses: dwin/[email protected]
    with:
      command: 'up'
    env:
      DATABASE_URL: postgres://postgres:changeme@postgres:5432/postgres # or ${{ secrets.DATABASE_URL }}
      DBMATE_MIGRATIONS_DIR: "./migrations"
      DBMATE_NO_DUMP_SCHEMA: "true"
      DBMATE_WAIT: "true"
      DBMATE_WAIT_TIMEOUT: "30s"
...

Check in the database schema

...
steps:
  - name: "Run migrations"
    uses: dwin/[email protected]
    with:
      command: 'up'
    env:
      DATABASE_URL: ${{ secrets.DATABASE_URL }}
      DBMATE_MIGRATIONS_DIR: "./migrations"
      DBMATE_SCHEMA_FILE: "./schema.sql"
      DBMATE_WAIT: "true"
      DBMATE_WAIT_TIMEOUT: "30s"
  - name: "Add & Commit latest schema"
    uses: EndBug/add-and-commit@v9
    with:
      default_author: github_actions
...

Dbmate action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Run Dbmate database migration tool
v1.15
Latest
By dwin

Dbmate action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.