Skip to content

Commit

Permalink
Merge pull request #1 from LUSHDigital/feature/infra-ref
Browse files Browse the repository at this point in the history
add reference for the infra folder
  • Loading branch information
zeevallin authored Sep 17, 2019
2 parents 6991192 + 1e076d0 commit f5bd911
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ To setup a project using mage, you can simply run the setup command in the root
$ mage setup:all
```

#### Reference: infra
Once the setup has completed, you will notice under the `infra/` folder that some files have been created. Here is a quick reference:

- `local.env` defines environment variables when running your application with `go run` or `go build`
- `dev.env` defines environment variables when running your application with `mage dev:service`
- `test.env` defines environment variables when running your application with `mage test`
- `staging.gcp.yml` defines environment variables & configuration options when running your application within the `staging` cluster
- `prod.gcp.yml` defines environment variables & configuration options when running your application within the `production` cluster

Note that `dev.env` and `test.env` are useful to avoid having to fiddle with docker-compose definitions.

### Test
Every project should have tests, yours is no exception. These mage targets make it easy to both run and manage your test environment. To run your tests, simply run the target and let mage to the rest.

Expand Down

0 comments on commit f5bd911

Please sign in to comment.