Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions {{cookiecutter.project_name}}/docs/template_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,16 @@ The following hints may be useful to work with the template sync:
[list of template repositories]: https://github.com/scverse/ecosystem-packages/blob/main/template-repos.yml
[scverse-bot]: https://github.com/scverse-bot

### Manual template sync

If you prefer to check for and apply the pre-release template updates manually, or if you are working on a private repository not tracked by the bot, you can use cruft. Simply:

- Make sure cruft and pre-commit are installed.
- Make sure your git directory is clean (no unstaged/uncommitted files).
- Run `cruft update` in the root of your repository.

Cruft will check if a newer version of the template is available. If so, it will show you the diff and ask for confirmation before applying the changes to your local files.

## Moving forward

You have successfully set up your project and are ready to start.
Expand Down
1 change: 1 addition & 0 deletions {{cookiecutter.project_name}}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ run.source = [ "{{ cookiecutter.package_name }}" ]

[tool.cruft]
skip = [
".git",
"tests",
"src/**/__init__.py",
"src/**/basic.py",
Expand Down
Loading