Merge branch 'main' into refactor/can-render-everything

Author: lwjohnst86

.cz.toml

@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "0.16.5"
+version = "0.17.4"
 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,42 @@ 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.4 (2025-09-02)
+
+### Refactor
+
+- :wrench: add more items to sidebar, like overview (#182)
+
+## 0.17.3 (2025-09-02)
+
+### Refactor
+
+- :recycle: create homepage as variable, not question (#179)
+
+## 0.17.2 (2025-09-02)
+
+### Refactor
+
+- :hammer: ignore `justfile` when listing TODO items (#181)
+
+## 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

copier.yaml

@@ -72,11 +72,6 @@ hosting_provider:
     - netlify
     - gh-pages
 
-homepage:
-  type: str
-  help: "What is the homepage of your project?"
-  default: "{{ 'https://%s.seedcase-project.org' % github_repo if is_seedcase_project else '' }}"
-
 author_given_name:
   type: str
   help: "What is your first/given name?"
@@ -116,3 +111,8 @@ copyright_year:
   type: str
   default: "{{ copyright_year | default('%Y' | strftime) }}"
   when: false
+
+homepage:
+  type: str
+  default: "https://{{ github_repo }}.{{ github_user }}.org"
+  when: false

justfile

@@ -51,6 +51,11 @@ check-spelling:
 test is_seedcase_project="true" hosting_provider="netlify":
   sh ./test-template.sh {{ is_seedcase_project }} {{ hosting_provider }}
 
+# Test template with the manual questionnaire answers
+test-manual:
+  mkdir -p _temp/manual-test/
+  uvx copier copy --trust -r HEAD . _temp/manual-test
+
 # Clean up any leftover and temporary build files
 cleanup:
   rm -rf _temp

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,10 +15,12 @@ authors:
   #   affiliation: ""
 cff-version: 1.2.0
 # doi:
+# date-released: ""
 keywords:
   # TODO: Add keywords relevant to the project.
   - ""
 license: MIT
 message: "If you use this Python package, please cite it using these metadata."
 repository-code: "https://github.com/{{ github_repo_spec }}"
+# TODO: Confirm URL
 url: "{{ homepage }}"

template/_quarto.yml.jinja

@@ -1,8 +1,6 @@
 project:
   # TODO: change to extension name if using a custom extension
   type: website
-  # Delete auto-generated files from `quartodoc`
-  post-render: rm -f docs/reference/*.qmd
 
 website:
   # TODO: Fill in the title of the website.
@@ -27,10 +25,14 @@ website:
     logo-alt: "{{ github_repo }} logo: Main page"
     {%- endif %}
     left:
+      - text: "Overview"
+        href: docs/index.qmd
       - text: "Guide"
         href: docs/guide/index.qmd
       - text: "Design"
         href: docs/design/index.qmd
+      # - text: "Reference"
+      #   href: docs/reference/index.qmd
     tools:
       - icon: github
         href: "https://github.com/{{ github_repo_spec }}"
@@ -41,9 +43,14 @@ website:
         aria-label: "House icon: Main website for the Seedcase Project"
       {%- endif %}
   sidebar:
-    - id: design
+    - id: overview
       pinned: true
       style: "floating"
+      contents:
+        - docs/index.qmd
+        - CHANGELOG.qmd
+        - CONTRIBUTING.md
+    - id: design
       contents:
         - text: "Design"
           href: docs/design/index.qmd

template/docs/index.qmd

@@ -0,0 +1,3 @@
+---
+title: "Overview"
+---