|
1 | | -# Essential questions |
| 1 | +--- |
| 2 | +# General settings for copier |
| 3 | +!include copier/settings.yml |
2 | 4 |
|
3 | | -package_name: |
4 | | - type: str |
5 | | - default: my_python_package |
6 | | - help: Enter the name of the Python package. |
7 | | - validator: >- |
8 | | - {% if not (package_name | regex_search('^[a-z][a-z0-9\_]+$')) %} |
9 | | - package_name must start with a letter, followed one or more letters, digits or underscores all lowercase. |
10 | | - {% endif %} |
11 | | -package_short_description: |
12 | | - type: str |
13 | | - default: Short description of package |
14 | | -keyword1: |
15 | | - type: str |
16 | | - default: keyword1 |
17 | | -keyword2: |
18 | | - type: str |
19 | | - default: keyword2 |
20 | | -version: |
21 | | - type: str |
22 | | - default: 0.1.0 |
23 | | -github_organization: |
24 | | - type: str |
25 | | - default: "<my-github-organization>" |
26 | | - help: Enter the name of your GitHub username or organization |
27 | | -full_name: |
28 | | - type: str |
29 | | - default: Jane Smith |
30 | | - help: Enter your full name. |
31 | | -email: |
32 | | - type: str |
33 | | - default: yourname@esciencecenter.nl |
34 | | -copyright_holder: |
35 | | - type: str |
36 | | - default: Netherlands eScience Center |
37 | | -code_of_conduct_email: |
38 | | - type: str |
39 | | - default: "{{ email }}" |
| 5 | +--- |
| 6 | +# profiles |
| 7 | +!include copier/profiles.yml |
40 | 8 |
|
41 | | -# calculated fields |
42 | | -repository: |
43 | | - default: git@github.com:{{ github_organization }}/{{ package_name }} |
44 | | - when: false |
| 9 | +--- |
| 10 | +# essential questions about the package details |
| 11 | +!include copier/questions/essential.yml |
45 | 12 |
|
46 | | -repository_url: |
47 | | - default: https://github.com/{{ github_organization }}/{{ package_name }} |
48 | | - when: false |
| 13 | +--- |
| 14 | +# additional questions about the package details |
| 15 | +!include copier/questions/package_details.yml |
49 | 16 |
|
| 17 | +--- |
| 18 | +# Features |
| 19 | +!include copier/questions/features.yml |
50 | 20 |
|
51 | | -# profile selection |
52 | | -template_profile: |
53 | | - type: str |
54 | | - default: recommended |
55 | | - help: Optional questions (You can use our defaults, or the bare minimum, or decide everything) |
56 | | - choices: |
57 | | - Recommended (our defaults for research software): "recommended" |
58 | | - Minimum (no extra features): "minimum" |
59 | | - Let me choose (decide each feature yourself): "ask" |
60 | | - |
61 | | - |
62 | | -# extra questions |
63 | | -license: |
64 | | - type: str |
65 | | - choices: |
66 | | - - "Apache Software License 2.0" |
67 | | - - "MIT license" |
68 | | - - "BSD license" |
69 | | - - "ISC license" |
70 | | - - "GNU General Public License v3 or later" |
71 | | - - "GNU Lesser General Public License v3 or later" |
72 | | - - "Not open source" |
73 | | - default: "MIT license" |
74 | | - |
75 | | -AddLinkCheck: |
76 | | - when: "{{ template_profile == 'ask' }}" |
77 | | - type: bool |
78 | | - default: "{{ template_profile != 'minimum' }}" |
79 | | - help: Do you want to add a GitHub action to check broken links? |
80 | | - |
81 | | -AddGitHubActions: |
82 | | - when: "{{ template_profile == 'ask' }}" |
83 | | - type: bool |
84 | | - default: "{{ template_profile != 'minimum' }}" |
85 | | - help: GitHub actions to test the package and the documentation |
86 | | - |
87 | | -AddCitation: |
88 | | - when: "{{ template_profile == 'ask' }}" |
89 | | - type: bool |
90 | | - default: "{{ template_profile != 'minimum' }}" |
91 | | - help: Citation file and cffconvert workflow which validates the citation file |
92 | | - |
93 | | -AddChangeLog: |
94 | | - when: "{{ template_profile == 'ask' }}" |
95 | | - type: bool |
96 | | - default: "{{ template_profile != 'minimum' }}" |
97 | | - help: Add a change log to keep track of changes in the package |
98 | | - |
99 | | -AddOnlineDocumentation: |
100 | | - when: "{{ template_profile == 'ask' }}" |
101 | | - type: bool |
102 | | - default: "{{ template_profile != 'minimum' }}" |
103 | | - help: Online documentation using Read the Docs |
104 | | - |
105 | | -AddPreCommit: |
106 | | - when: "{{ template_profile == 'ask' }}" |
107 | | - type: bool |
108 | | - default: "{{ template_profile != 'minimum' }}" |
109 | | - help: Add pre-commit hook to check code style and format on every commit? |
110 | | - |
111 | | -AddZenodo: |
112 | | - when: "{{ template_profile == 'ask' }}" |
113 | | - type: bool |
114 | | - default: "{{ template_profile != 'minimum' }}" |
115 | | - help: Create a GitHub issue on how to enable Zenodo integration? |
116 | | - |
117 | | -AddSonarCloud: |
118 | | - when: "{{ template_profile == 'ask' }}" |
119 | | - type: bool |
120 | | - default: "{{ template_profile != 'minimum' }}" |
121 | | - help: Add SonarCloud (code analysis service) integration? |
122 | | - |
123 | | -AddContributing: |
124 | | - when: "{{ template_profile == 'ask' }}" |
125 | | - type: bool |
126 | | - default: "{{ template_profile != 'minimum' }}" |
127 | | - help: Add contributing guidelines? |
128 | | - |
129 | | -# internal fields |
130 | | -_subdirectory: template |
131 | | - |
132 | | -# user messages |
133 | | -_message_before_copy: | |
134 | | - Thanks for generating a project using our template. |
135 | | -
|
136 | | - You'll be asked a series of questions whose answers will be used to |
137 | | - generate a tailored project for you. |
138 | | -
|
139 | | -_message_after_copy: | |
140 | | - Your project "{{ package_name }}" has been created successfully! |
141 | | -
|
142 | | - Next steps: |
143 | | -
|
144 | | - 1. Change directory to the project root: |
145 | | -
|
146 | | - $ cd {{ _copier_conf.dst_path }} |
147 | | -
|
148 | | - 2. Read next_steps.md which contains information on next steps. |
149 | | -
|
150 | | -_message_before_update: | |
151 | | - Thanks for updating your project using our template. |
152 | | -
|
153 | | - You'll be asked a series of questions whose answers are pre-populated |
154 | | - with previously entered values. Feel free to change them as needed. |
155 | | -
|
156 | | -_message_after_update: | |
157 | | - Your project "{{ package_name }}" has been updated successfully! |
158 | | - In case there are any conflicts, please resolve them. Then, |
159 | | - you're done. |
| 21 | +--- |
| 22 | +# User messages |
| 23 | +!include copier/messages.yml |
0 commit comments