spatialdata-plot icon indicating copy to clipboard operation
spatialdata-plot copied to clipboard

Update template to v0.5.0

Open scverse-bot opened this issue 7 months ago • 0 comments

cookiecutter-scverse released v0.5.0.

Changes

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.

  • Generate real merge conflicts on template update by @grst in https://github.com/scverse/cookiecutter-scverse/pull/364

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 https://github.com/scverse/cookiecutter-scverse/pull/308
  • Upgrade Github actions by @Zethson in https://github.com/scverse/cookiecutter-scverse/pull/324
  • Use hatch in github actions by @grst in https://github.com/scverse/cookiecutter-scverse/pull/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 https://github.com/scverse/cookiecutter-scverse/pull/304
  • TOML formatting using pyproject-fmt by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/299

We added (optional) integration with VScode and improved cookiecutter prompts:

  • Add VS Code integration by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/312
  • Add prompts for most variables by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/319

We removed bump2version as recommended way to update versions. Instead, just update the version manually in pyproject.toml or use hatch-vcs

  • Remove bump2version by @Zethson in https://github.com/scverse/cookiecutter-scverse/pull/367

Fixes

  • Fix PyPI link in README by @grst in https://github.com/scverse/cookiecutter-scverse/pull/286
  • Fix autosummary template by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/297
  • Fix string syntax in hook output by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/305
  • Fix repo metadata by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/307
  • Fix links by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/309
  • Update post-gen output for hatch by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/311
  • Fix README links by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/321
  • Hatch extra-features doesn’t exist by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/326
  • Update / fix README template by @le-ander in https://github.com/scverse/cookiecutter-scverse/pull/356
  • Exclude .cruft.json from biome hook by @grst in https://github.com/scverse/cookiecutter-scverse/pull/362
  • Switch to session-info2 by @Zethson in https://github.com/scverse/cookiecutter-scverse/pull/366
  • Use cruft in github action that creates instance repo by @grst in https://github.com/scverse/cookiecutter-scverse/pull/371
  • Even more precautionary bash settings by @grst in https://github.com/scverse/cookiecutter-scverse/pull/377

Documentation

  • Add instructions on how to migrate an existing project to using the template by @grst in https://github.com/scverse/cookiecutter-scverse/pull/289
  • fix hatch snippets for docs build in contributing.md by @eroell in https://github.com/scverse/cookiecutter-scverse/pull/328
  • Add instructions for a pending publisher by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/358
  • Add Github Actions documentation and simplify template usage by @Zethson in https://github.com/scverse/cookiecutter-scverse/pull/369
  • Add more elaborate example by @Zethson in https://github.com/scverse/cookiecutter-scverse/pull/365
  • Suggest to use uv to run cruft by @grst in https://github.com/scverse/cookiecutter-scverse/pull/370

Chore

  • Remove test reliance on unmaintained pytest-git by @flying-sheep in https://github.com/scverse/cookiecutter-scverse/pull/298
  • pre-commit updates

New Contributors

  • @eroell made their first contribution in https://github.com/scverse/cookiecutter-scverse/pull/328
  • @le-ander made their first contribution in https://github.com/scverse/cookiecutter-scverse/pull/356
  • @scverse-bot made their first contribution in https://github.com/scverse/cookiecutter-scverse/pull/371

Full Changelog: https://github.com/scverse/cookiecutter-scverse/compare/v0.4.0...v0.5.0

Additional remarks

  • unsubscribe: If you don’t want to receive these PRs in the future, add skip: true to template-repos.yml using a PR or, if you never want to sync from the template again, delete the .cruft.json file in the root of your repository.
  • If there are merge conflicts, you need to resolve them manually.
  • The scverse template works best when the pre-commit.ci, readthedocs and codecov services are enabled. Make sure to activate those apps if you haven't already.

scverse-bot avatar Apr 02 '25 18:04 scverse-bot