Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README for Copier v8 compatibility #391

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,17 @@ pipx ensurepath
Once you installed everything, you can now use Copier to copy this template:

```bash
copier copy gh:Tecnativa/doodba-copier-template ~/path/to/your/subproject
copier copy --UNSAFE gh:Tecnativa/doodba-copier-template ~/path/to/your/subproject
```

Copier will ask you a lot of questions. Answer them to properly generate the template.

The `--UNSAFE` flag is necessary since
[Copier v8](https://copier.readthedocs.io/en/stable/configuring/#unsafe) to use features
such as Jinja extensions, Migrations and Tasks.

Make sure you trust the code you're executing!

Notes:

- The backup service will not be deployed when using postgresql 9.6.
Expand All @@ -83,13 +89,13 @@ If you always used Copier with this project, getting last updates with Copier is

```bash
cd ~/path/to/your/downstream/scaffolding
copier update
copier update --UNSAFE
```

Copier will ask you all questions again, but default values will be those you answered
last time. Just hit <kbd>Enter</kbd> to accept those defaults, or change them if
needed... or you can use `copier --force update` instead to avoid answering again all
things.
needed... or you can use `copier update --force --UNSAFE` instead to avoid answering
everything again.

Basically, read Copier docs and `copier --help-all` to know how to use it.

Expand Down Expand Up @@ -124,6 +130,6 @@ VM to work with doodba without problems. If you use other systems and find a way
these tools work, please consider [opening a PR](#contributing) to add some docs that
might help others with your situation.

[copier]: https://github.com/pykong/copier
[copier]: https://github.com/copier-org/copier
[doodba]: https://github.com/Tecnativa/doodba
[odoo]: https://www.odoo.com/