Skip to content

Commit 81fb2e2

Browse files
authored
Merge pull request #451 from NLeSC/430_minimal_profile
add minimal profile
2 parents d45829b + 81fb952 commit 81fb2e2

File tree

4 files changed

+64
-16
lines changed

4 files changed

+64
-16
lines changed

copier.yml

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,6 @@ version:
2323
github_organization:
2424
type: str
2525
default: "<my-github-organization>"
26-
license:
27-
type: str
28-
choices:
29-
- "Apache Software License 2.0"
30-
- "MIT license"
31-
- "BSD license"
32-
- "ISC license"
33-
- "GNU General Public License v3 or later"
34-
- "GNU Lesser General Public License v3 or later"
35-
- "Not open source"
36-
default: "MIT license"
3726
full_name:
3827
type: str
3928
default: Jane Smith
@@ -48,8 +37,7 @@ code_of_conduct_email:
4837
type: str
4938
default: "{{ email }}"
5039

51-
_subdirectory: template
52-
40+
# calculated fields
5341
repository:
5442
default: [email protected]:{{ github_organization }}/{{ package_name }}
5543
when: false
@@ -59,11 +47,42 @@ repository_url:
5947
when: false
6048

6149

62-
# Optional questions
50+
# profile selection
51+
template_profile:
52+
type: str
53+
default: recommended
54+
help: Optional questions (You can use our defaults, or the bare minimum, or decide everything)
55+
choices:
56+
Recommended (our defaults for research software): "recommended"
57+
Minimum (no extra features): "minimum"
58+
Let me choose (decide each feature yourself): "ask"
6359

6460

65-
# user messages
61+
# extra questions
62+
license:
63+
type: str
64+
choices:
65+
- "Apache Software License 2.0"
66+
- "MIT license"
67+
- "BSD license"
68+
- "ISC license"
69+
- "GNU General Public License v3 or later"
70+
- "GNU Lesser General Public License v3 or later"
71+
- "Not open source"
72+
default: "MIT license"
73+
74+
AddGitHubActions:
75+
when: "{{ template_profile == 'ask' }}"
76+
type: bool
77+
default: "{{ template_profile != 'minimum' }}"
78+
help: GitHub actions to test the package and the documentation
79+
6680

81+
# internal fields
82+
_subdirectory: template
83+
84+
85+
# user messages
6786
_message_before_copy: |
6887
Thanks for generating a project using our template.
6988
@@ -77,7 +96,7 @@ _message_after_copy: |
7796
7897
1. Change directory to the project root:
7998
80-
$ cd {{ _copier_conf.dst_path }}
99+
$ cd {{ _copier_conf.dst_path }}
81100
82101
2. Read next_steps.md which contains information on next steps.
83102

profiles.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Template Profiles
2+
3+
4+
## Minimum
5+
6+
- src/
7+
- docs/
8+
- test/
9+
- pyproject.toml
10+
- README.md
11+
- .gitignore
12+
- .editorconfig
13+
14+
15+
## Questions
16+
- licence (exist)
17+
- github action (exist) #451
18+
- Pre-commit
19+
- cffconvert workflow and citation file
20+
- markdown link checker workflow
21+
- static analysis
22+
- next steps workflow
23+
- changelog
24+
- code of conduct
25+
- contributing guidelines
26+
- notice and manifest file
27+
- developer documentation
28+
- online documentation (read the docs)
29+

template/.github/workflows/build.yml renamed to template/.github/workflows/{% if AddGitHubActions %}build.yml{% endif %}

File renamed without changes.

template/.github/workflows/documentation.yml renamed to template/.github/workflows/{% if AddGitHubActions %}documentation.yml{% endif %}

File renamed without changes.

0 commit comments

Comments
 (0)