Merge branch 'main' into refactor/homepage-as-setting-not-question

Author: signekb

.cz.toml

@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "0.16.4"
+version = "0.17.1"
 bump_message = "build(version): :bookmark: update version from $current_version to $new_version"
 version_schema = "semver"
 version_provider = "commitizen"

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@4959332f0f014c5280e7eac8b70c90cb574c9f9b
+        uses: astral-sh/setup-uv@557e51de59eb14aaaba2ed9621916900a91d50c6
         with:
           enable-cache: true
 

.pre-commit-config.yaml

@@ -25,6 +25,6 @@ repos:
   # sub-packages, which confuses pre-commit when it tries to find the latest
   # version
   - repo: https://github.com/adhtruong/mirrors-typos
-    rev: v1.35.5
+    rev: v1.35.6
     hooks:
       - id: typos

CHANGELOG.md

@@ -10,6 +10,30 @@ a day. It also means any individual release will not have many changes
 within it. Below is a list of releases along with what was changed
 within it.
 
+## 0.17.1 (2025-09-02)
+
+### Refactor
+
+- :recycle: need `date-released` in `CITATION.cff` (#180)
+
+## 0.17.0 (2025-09-02)
+
+### Feat
+
+- :sparkles: add CHANGELOG with some description of it (#178)
+
+## 0.16.6 (2025-09-02)
+
+### Refactor
+
+- :recycle: delete whole references folder pre and post render (#142)
+
+## 0.16.5 (2025-09-01)
+
+### Refactor
+
+- :truck: move GoatCounter file into `docs/includes/` (#177)
+
 ## 0.16.4 (2025-09-01)
 
 ### Refactor

CITATION.cff

@@ -17,8 +17,8 @@ authors:
     given-names: Marton
     affiliation: "Steno Diabetes Center Aarhus"
 cff-version: 1.2.0
-# doi:
-# date:
+doi: 10.5281/zenodo.17018496
+date-released: 2025-09-01
 keywords:
   - "copier template"
   - "template"

README.md

@@ -2,8 +2,7 @@
 
 # Template Python Package: An opinionated setup for making Python packages
 
-<!-- [![DOI]()]() -->
-
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018496.svg)](https://doi.org/10.5281/zenodo.17018496)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
 [![GitHub
 License](https://img.shields.io/github/license/seedcase-project/template-python-package.svg)](https://github.com/seedcase-project/template-python-package/blob/main/LICENSE.md)
@@ -66,14 +65,18 @@ effort to create a framework for data management and analysis in
 research. If you use this project in your work, please cite it as
 follows:
 
-Johnston L.W., Brødbæk S.K., Beicher K., Vago M. Template Python
-Package: An opinionated setup for making Python packages URL:
+Johnston L.W., Brødbæk S.K., Beicher K., Vago M. (2025). Template Python
+Package: An opinionated setup for making Python packages DOI:
+10.5281/zenodo.17018496 URL:
 https://template-python-package.seedcase-project.org
 
 Or as a BibTeX entry:
 
     @misc{YourReferenceHere,
     author = {Johnston, Luke William and Brødbæk, Signe Kirk and Beicher, Kristiane and Vago, Marton},
+    doi = {10.5281/zenodo.17018496},
+    month = {9},
     title = {Template Python Package: An opinionated setup for making Python packages},
-    url = {https://template-python-package.seedcase-project.org}
+    url = {https://template-python-package.seedcase-project.org},
+    year = {2025}
     }

docs/includes/_badges.qmd

@@ -1,4 +1,4 @@
-<!-- [![DOI]()]() -->
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018496.svg)](https://doi.org/10.5281/zenodo.17018496)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
 [![GitHub License](https://img.shields.io/github/license/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/blob/main/LICENSE.md)
 [![GitHub Release](https://img.shields.io/github/v/release/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/releases/latest)

index.qmd

@@ -59,6 +59,9 @@ including for developing the package.
     [`seedcase-theme`](https://github.com/{{< meta gh.org >}}/seedcase-theme)
     Quarto extension for a standard appearance across websites.
 -   Uses [Netlify](https://www.netlify.com/) for hosting the website.
+-   Includes a [GoatCounter](https://www.goatcounter.com/) file for website visitor
+    tracking, which is privacy-friendly and does not use cookies. That means
+    it doesn't need a GDPR notice as no personal data is collected.
 
 ## Want to contribute?
 

template/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+Since we follow [Conventional
+Commits](https://decisions.seedcase-project.org/why-conventional-commits),
+we're able to automatically create a release based on the commit message
+by using
+[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen).
+This means that releases can happen quite often, sometimes several in
+a day. It also means any individual release will not have many changes
+within it. Below is a list of releases along with what was changed
+within it.

template/CITATION.cff.jinja

@@ -15,6 +15,7 @@ authors:
   #   affiliation: ""
 cff-version: 1.2.0
 # doi:
+# date-released: ""
 keywords:
   # TODO: Add keywords relevant to the project.
   - ""