Update docs (#175)

This commit is contained in:
Adrian Macneil 2020-11-10 14:09:53 +13:00 committed by GitHub
parent c2b14bb7e0
commit 656dc0253a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 7 deletions

View file

@ -1,6 +1,6 @@
# Dbmate # Dbmate
[![Build Status](https://travis-ci.org/amacneil/dbmate.svg?branch=master)](https://travis-ci.org/amacneil/dbmate) [![GitHub Build](https://img.shields.io/github/workflow/status/amacneil/dbmate/CI/master)](https://github.com/amacneil/dbmate/actions?query=branch%3Amaster+event%3Apush+workflow%3ACI)
[![Go Report Card](https://goreportcard.com/badge/github.com/amacneil/dbmate)](https://goreportcard.com/report/github.com/amacneil/dbmate) [![Go Report Card](https://goreportcard.com/badge/github.com/amacneil/dbmate)](https://goreportcard.com/report/github.com/amacneil/dbmate)
[![GitHub Release](https://img.shields.io/github/release/amacneil/dbmate.svg)](https://github.com/amacneil/dbmate/releases) [![GitHub Release](https://img.shields.io/github/release/amacneil/dbmate.svg)](https://github.com/amacneil/dbmate/releases)
@ -46,13 +46,13 @@ $ sudo chmod +x /usr/local/bin/dbmate
You can run dbmate using the official docker image (remember to set `--network=host` or see [this comment](https://github.com/amacneil/dbmate/issues/128#issuecomment-615924611) for more tips on using dbmate with docker networking): You can run dbmate using the official docker image (remember to set `--network=host` or see [this comment](https://github.com/amacneil/dbmate/issues/128#issuecomment-615924611) for more tips on using dbmate with docker networking):
```sh ```sh
$ docker run --rm --network=host -it amacneil/dbmate --help $ docker run --rm -it --network=host amacneil/dbmate --help
``` ```
If you wish to create or apply migrations, you will need to use Docker's [bind mount](https://docs.docker.com/storage/bind-mounts/) feature to make your local working directory available inside the dbmate container: If you wish to create or apply migrations, you will need to use Docker's [bind mount](https://docs.docker.com/storage/bind-mounts/) feature to make your local working directory (`pwd`) available inside the dbmate container:
```sh ```sh
$ docker run --rm -it -v "$(pwd)"/db:/db amacneil/dbmate new create_users_table $ docker run --rm -it --network=host -v "$(pwd)/db:/db" amacneil/dbmate new create_users_table
``` ```
**Heroku** **Heroku**

View file

@ -3,6 +3,5 @@
The following steps should be followed to publish a new version of dbmate (requires write access to this repository). The following steps should be followed to publish a new version of dbmate (requires write access to this repository).
1. Update [version.go](/pkg/dbmate/version.go) with new version number ([example PR](https://github.com/amacneil/dbmate/pull/146/files)) 1. Update [version.go](/pkg/dbmate/version.go) with new version number ([example PR](https://github.com/amacneil/dbmate/pull/146/files))
2. Create new release on GitHub project [releases page](https://github.com/amacneil/dbmate/releases) 2. Create new release on [releases page](https://github.com/amacneil/dbmate/releases) and write release notes
3. Travis CI will automatically publish release binaries to GitHub 3. GitHub Actions will automatically publish release binaries and submit Homebrew PR
4. GitHub Actions will automatically create PR to update Homebrew package