diff --git a/.github/workflows/blueprint-docs.yml b/.github/workflows/blueprint-docs.yml index d849fb8..01a7283 100644 --- a/.github/workflows/blueprint-docs.yml +++ b/.github/workflows/blueprint-docs.yml @@ -19,7 +19,7 @@ jobs: - name: Create new project run: | # Note: Make sure python_version is consistent with python-version hardcoded above - conda run --name blueprint copier --force --vcs-ref=HEAD python_version=3.9 copy . ./docs/example_project + conda run --name blueprint copier --force --vcs-ref=HEAD copy . ./docs/example_project ls echo "===================================" ls docs diff --git a/README.md b/README.md index 88e536d..22790b6 100644 --- a/README.md +++ b/README.md @@ -42,18 +42,19 @@ conda create --name blueprint conda activate blueprint conda install "copier<8.0" ``` +Make sure to have at least copier version 8.1.0. Otherwise, please update copier. ## Create your Python package from our template You can now produce your Python package from a copier template by running ``` conda activate blueprint -copier git@github.com:MeteoSwiss-APN/mch-python-blueprint.git +copier copy git@github.com:MeteoSwiss-APN/mch-python-blueprint.git ``` If you need to generate your project from a specific commit hash or branch of the blueprint you can run with --vcs-ref ``` conda activate blueprint -copier --vcs-ref git@github.com:MeteoSwiss-APN/mch-python-blueprint.git +copier copy --vcs-ref git@github.com:MeteoSwiss-APN/mch-python-blueprint.git ``` **Warning:** @@ -91,7 +92,7 @@ out more about provided development tools and setting up CI/CD pipelines on http To update your package to the latest version of the underlying meta template, run: ```bash -copier -a .copier-answers.yml -f update +copier update -a .copier-answers.yml -f update ``` With `-f`, conflicting files are overwritten (which doesn't mean that in the end, the files are changed as those conflicts can be purely internal). diff --git a/copier.yaml b/copier.yaml index 24731be..2407bc3 100644 --- a/copier.yaml +++ b/copier.yaml @@ -76,5 +76,5 @@ python_version: year: help: "This year" - default: "2022" + default: "2023" type: str diff --git a/pyproject.toml b/pyproject.toml index 77f6f6d..fd7f14e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,5 +31,16 @@ ignore_directives = [ ] [tool.codespell] -ignore-words-list = "inout" -skip = "requirements/*" +ignore-regex = '(\b[A-Z]+\b|.*([#!"]|