Skip to content

Commit

Permalink
doc: update README with default config example
Browse files Browse the repository at this point in the history
  • Loading branch information
EliuX committed Mar 2, 2024
1 parent c441c69 commit 29fef47
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,24 @@ plugins:
- serverless-migrate-plugin
```
1. Add a migrate configuration in the `custom` section of your _serverless.yml_:
1. Add a `custom.migrate` section to your _serverless.yml_:

```yaml
custom:
migrate:
stateFile: .migrate2
store: ./sample-store
lastRunIndicator: <*****
lastRunIndicator: <
noDescriptionText: '?'
ignoreMissing: true
dateFormat: 'yyyy-MM-dd hh:mm:ssZ'
templateFile: 'my-project-template.js'
migrationDir: 'migrations-for-tests'
dateFormat: "yyyy-MM-dd hh:mm:ssZ"
templateFile: "my-project-template.js"
environment:
ANOTHER_ENV: overrriden value
COMPLEX_VAR: ${self:provider.env.ANOTHER_ENV, 'unexistent'}
BOOLEAN_ENV: false
# fileExtension: .ss # Uncomment to check it will not work
```

You can learn more about these variables in the [example](./example/README.md#custom-variables).

1. Create your first migration:

```bash
Expand Down

0 comments on commit 29fef47

Please sign in to comment.