Skip to content

docs(copier): explicitly lists defaults #37

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.

Sign up for GitHub

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

Open
Matt-Carre wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(copier): explicitly lists defaults #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions copier.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,21 @@ repo_name:
help: |
What is the name for your new repo?
Generally, use the package name with underscores replaced by dashes.
(default = your project name with '-' rather than '_')
default: "{{ project_name | replace('_', '-') }}"
validator: >-
{% if not (repo_name | regex_search('^[a-zA-Z0-9](?:[a-zA-Z0-9_.-]*[a-zA-Z0-9])?$')) %}
{{ repo_name }} is not a valid repo name
{% endif %}

description:
type: str
help: Please provide a description of your project
placeholder: One line description of your module

github_org:
type: str
help: What is your github organisation?
help: What is your github organisation? (default = DiamondLightSource)
default: DiamondLightSource

author_name:
Expand All @@ -35,6 +37,6 @@ author_name:
author_email:
type: str
help: What is your email address?
placeholder: email@diamond.ac.uk
placeholder: your.name@diamond.ac.uk

_subdirectory: "src/copier_template"
Loading