Releases: scverse/cookiecutter-scverse
v0.6.0
CI updates
We now more consistently embrace hatch and uv in the template. CI now generates the job matrix from that hatch configuration. This means the pyproject.toml
file is now the one single point of truth for both local and CI test jobs.
- Get test matrix from hatch by @grst in #390
- Enable parallel testing with hatch by @grst in #430
- chore: update code cov by
@ilan-gold
in #427 - Fix remaining uv cache globs in workflows by
@flying-sheep
in #388 - Switch root tests to uv by
@flying-sheep
in #384 - Fix uv cache glob for script tests by
@flying-sheep
in #387 - Test pre-release dependencies by @grst in #393
- Use hatch on RTD by @grst in #402
- Fix ruff-check naming by
@Zethson
in #414 - fix codecov upload (closes #381) by
@ilia-kats
in #382
Documentation updates
We improved the "contributing guide" that is also synced into the repos using this template to recommend hatch
as the default project manager.
- Fix repo migration commands by
@le-ander
in #380 - Delete docs/Makefile by @grst in #383
- restore missing links by
@Zethson
in #411 - Update documentation by @grst in #406
Chore
- Update pre-commit config
- Re-enable dry-run for release by @grst in #394
- Create template sync PRs from versioned branch by @grst in #401
Full Changelog: v0.5.0...v0.6.0
v0.5.0
New template sync
We re-implemented template sync from scratch instead on relying on cruft. This allows us to create real merge conflicts that show up as such on GitHub instead of .rej
files.
Enhancements
We committed to using hatch as project and environment manager. By doing so, we simplified the
GitHub actions:
- Hatch envs by @flying-sheep in #308
- Upgrade Github actions by @Zethson in #324
- Use hatch in github actions by @grst in #373
We switched the pre-commit hook from prettier to biome and added a pre-commit hook for autoformatting pyproject.toml
files:
- Switch from prettier to Biome by @flying-sheep in #304
- TOML formatting using pyproject-fmt by @flying-sheep in #299
We added (optional) integration with VScode and improved cookiecutter prompts:
- Add VS Code integration by @flying-sheep in #312
- Add prompts for most variables by @flying-sheep in #319
We removed bump2version as recommended way to update versions. Instead, just update the version manually in pyproject.toml
or use hatch-vcs
Fixes
- Fix PyPI link in README by @grst in #286
- Fix autosummary template by @flying-sheep in #297
- Fix string syntax in hook output by @flying-sheep in #305
- Fix repo metadata by @flying-sheep in #307
- Fix links by @flying-sheep in #309
- Update post-gen output for hatch by @flying-sheep in #311
- Fix README links by @flying-sheep in #321
- Hatch
extra-features
doesn’t exist by @flying-sheep in #326 - Update / fix README template by @le-ander in #356
- Exclude .cruft.json from biome hook by @grst in #362
- Switch to session-info2 by @Zethson in #366
- Use cruft in github action that creates instance repo by @grst in #371
- Even more precautionary bash settings by @grst in #377
Documentation
- Add instructions on how to migrate an existing project to using the template by @grst in #289
- fix hatch snippets for docs build in contributing.md by @eroell in #328
- Add instructions for a pending publisher by @flying-sheep in #358
- Add Github Actions documentation and simplify template usage by @Zethson in #369
- Add more elaborate example by @Zethson in #365
- Suggest to use
uv
to run cruft by @grst in #370
Chore
- Remove test reliance on unmaintained pytest-git by @flying-sheep in #298
- pre-commit updates
New Contributors
- @eroell made their first contribution in #328
- @le-ander made their first contribution in #356
- @scverse-bot made their first contribution in #371
Full Changelog: v0.4.0...v0.5.0
v0.4.0
What's Changed
- pre-commit updates
- Fix installation instructions on contributing guide by @grst in #271
- fix typo by @Zethson in #279
- Use cookiecutter variable for project repo in conf.py by @Zethson in #278
- Add node_modules to .gitignore by @Zethson in #277
- Update required python versions according to scientific python SPEC 0 by @grst in #284
- Require myst-nb >= 1.1.0 by @grst in #285
Full Changelog: v0.3.1...v0.4.0
v0.3.1
Enhancements
- Use Ruff formatting, run Ruff on notebooks by @flying-sheep in #256
Fixes
- Unpin node version, pre-commit autoupdate by @pre-commit-ci in #255
- Fix copy without render by @grst in #263
- Fix Ruff deprecations by @flying-sheep in #267
Documentation
Full Changelog: v0.3.0...v0.3.1
v0.3.0
Required actions
The Github release
workflow has been updated to use trusted publishing for authentication. You'll need to configure your project on PyPI accordingly. See #228 and the PyPI documentation for more details.
Python version update
Python 3.11 now works with numba, so we increased the maximum tested version to Python 3.11.
Enhancements
The automatic template sync is now in regular operation 🎉
Fixes
- Reduce font size in data frames (#250)
- Remove template usage docs from rendered template (now only available in
cookiecutter-scverse-instance
(#247) - Remove sphinx setup function (#246)
- Move the section about how to configure the github release workflow to the template documentation (#248)
- Use
coverage run
instead ofpytest --cov
to compute test coverage (#244) - Fix that the LICENSE file wasn't generated for GPL (#245)
- Fix socket warning in tests (#240)
If there are any questions, feel free to reach out to @grst, e.g. on the scverse zulip.
v0.2.22
Fixes
- allow maintainers to modify PRs created by @scverse-bot which is required to manually fix merge conflicts.
Feel free to contact @grst on the scverse zulip in case of any questions.
v0.2.21
Dear scverse ecosystem developers,
we overhauled the automated template sync for our cookiecutter template.
Instead of a github action in your repo that runs a cronjob, PRs are now created in a centralized fashion by @scverse-bot.
We hope the new system finally works for all (most) repos and apologize for any "noise" PRs we may have created so far. Unfortunately, the system is a bit tricky to debug -- the only real way of testing it is to trigger an actual template sync.
In case you have any questions, feel free to reach out to @grst, for instance via the scverse zulip chat.