Skip to content

[Documentation] Small Typo #11

@donaldev

Description

@donaldev

Hi there,

I'm new to flywayDB and new to your plugin and spent the day trying to get this to work yesterday - I couldn't figure out what I was doing wrong.

In your first example :
"scripts": { "migrate": "flyway -X -configFile=conf/flyway.conf migrate" }
I believe it should be -configFiles=.
I know it's only small but for somebody new to the tool, all I was working off was that first example - I read the flywayDB docs in the end and found the correct flag.

Secondly, it might be useful to show a project directory structure example, here's mine after getting it working :
-App
--conf
---flyway.conf
--node_modules
--sql
--- all migrations here
--.gitignore
-- package.json
-- README.md

N.B make sure to set the flyway.locations flag in the config file :
flyway.locations=filesystem:./sql/ - the default is inside the node_modules/flywaydb-cli package, which wouldn't be added to source control.

Just a suggestion as it would have helped me out a lot.

Thanks for the work

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions