From 3846889a01e46f26a5a256a69ee5932a96c4d82c Mon Sep 17 00:00:00 2001 From: Olga Lyashevska Date: Mon, 26 Aug 2024 16:19:56 +0200 Subject: [PATCH 1/4] Make project setup optional --- CHANGELOG.md | 1 + copier/questions/features.yml | 5 +++++ template/README.md.jinja | 2 ++ ...% if AddProjectSetup %}project_setup.md{% endif %}.jinja} | 0 4 files changed, 8 insertions(+) rename template/{project_setup.md.jinja => {% if AddProjectSetup %}project_setup.md{% endif %}.jinja} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 24e904ba..1c1e6c54 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## [Unreleased] ### Added +* Make project_setup optional []() * Make contributing guidelines optional [#465]() * Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541) * Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530) diff --git a/copier/questions/features.yml b/copier/questions/features.yml index c5c6e185..3a7d46df 100644 --- a/copier/questions/features.yml +++ b/copier/questions/features.yml @@ -60,3 +60,8 @@ AddDevDoc: type: bool default: "{{ template_profile != 'minimum' }}" help: Add developer documentation? +AddProjectSetup: + when: "{{ template_profile == 'ask' }}" + type: bool + default: "{{ template_profile != 'minimum' }}" + help: Add project setup instructions? diff --git a/template/README.md.jinja b/template/README.md.jinja index 8523375a..d165c82c 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -30,11 +30,13 @@ | Link checker | [![link-check]({{repository_url}}/actions/workflows/link-check.yml/badge.svg)]({{repository_url}}/actions/workflows/link-check.yml) | {%- endif -%} +{% if AddProjectSetup -%} ## How to use {{ package_name }} {{ package_short_description|replace('\"', '\\\"') }} The project setup is documented in [project_setup.md](project_setup.md). Feel free to remove this document (and/or the link to this document) if you don't need it. +{%- endif %} ## Installation diff --git a/template/project_setup.md.jinja b/template/{% if AddProjectSetup %}project_setup.md{% endif %}.jinja similarity index 100% rename from template/project_setup.md.jinja rename to template/{% if AddProjectSetup %}project_setup.md{% endif %}.jinja From cd156c468846863e163868cf851317d1c10fc2cc Mon Sep 17 00:00:00 2001 From: Olga Lyashevska Date: Mon, 26 Aug 2024 16:21:52 +0200 Subject: [PATCH 2/4] Update changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c1e6c54..149cd045 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ## [Unreleased] ### Added -* Make project_setup optional []() +* Make project_setup optional [553](https://github.com/NLeSC/python-template/pull/553) * Make contributing guidelines optional [#465]() * Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541) * Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530) From 6da886ee43d91debe326fbafd31c7cf8208c7dc8 Mon Sep 17 00:00:00 2001 From: Olga Lyashevska Date: Mon, 26 Aug 2024 16:27:32 +0200 Subject: [PATCH 3/4] Rephrase changelog entry --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 149cd045..bf47702e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ## [Unreleased] ### Added -* Make project_setup optional [553](https://github.com/NLeSC/python-template/pull/553) +* Make project setup guidelines optional [553](https://github.com/NLeSC/python-template/pull/553) * Make contributing guidelines optional [#465]() * Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541) * Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530) From dc187d85fe5da5ccf6d22685c9f040d6eac649b6 Mon Sep 17 00:00:00 2001 From: Olga Lyashevska Date: Tue, 27 Aug 2024 11:37:09 +0200 Subject: [PATCH 4/4] Update copier/questions/features.yml Co-authored-by: fdiblen <144492+fdiblen@users.noreply.github.com> --- copier/questions/features.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/copier/questions/features.yml b/copier/questions/features.yml index 3a7d46df..f193e72d 100644 --- a/copier/questions/features.yml +++ b/copier/questions/features.yml @@ -64,4 +64,4 @@ AddProjectSetup: when: "{{ template_profile == 'ask' }}" type: bool default: "{{ template_profile != 'minimum' }}" - help: Add project setup instructions? + help: Add a document to describe project setup?