Merge branch 'main' into feat/add-missing-workflows

Author: lwjohnst86

.github/workflows/test.yml

@@ -14,10 +14,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba
+        uses: astral-sh/setup-uv@4959332f0f014c5280e7eac8b70c90cb574c9f9b
         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.4
+    rev: v1.35.5
     hooks:
       - id: typos

copier.yaml

@@ -9,23 +9,31 @@ _tasks:
 # Message to show after generating or regenerating the project successfully
 _message_after_copy: |
 
-  Your project "{{ package_name }}" has been created successfully!
+  Your project "{{ github_repo }}" has been created successfully!
 
-  Next steps:
+  See the [guide](https://template-python-package.seedcase-project.org/docs/guide) for more detail
+  on the next steps. Briefly:
 
   1. Change directory to the project root:
 
-    $ cd {{ _copier_conf.dst_path }}
+    ``` bash
+    cd {{ _copier_conf.dst_path | realpath }}
+    ```
 
-  2. Install the pre-commit hooks:
+  2. Install the pre-commit hooks, add (called "update" here) the Quarto extension,
+     and build the README:
 
-    $ just install-precommit
+    ``` bash
+    just install-precommit update-quarto-theme build-readme
+    ```
 
-  3. Install [`spaid`](https://github.com/seedcase-project/spaid) and run these commands to upload and configure your project on GitHub:
+  3. Install [`spaid`](https://github.com/seedcase-project/spaid) and run these setup steps:
 
-    $ spaid_gh_create_repo_from_local -h
-    $ spaid_gh_set_repo_settings -h
-    $ spaid_gh_ruleset_basic_protect_main -h
+    ``` bash
+    spaid_gh_create_repo_from_local -h
+    spaid_gh_set_repo_settings -h
+    spaid_gh_ruleset_basic_protect_main -h
+    ```
 
   4. Configure GitHub following this
     [guide](https://guidebook.seedcase-project.org/operations/security#using-github-apps-to-generate-tokens):
@@ -37,46 +45,37 @@ _message_after_copy: |
 
   5. List and complete all TODO items in the repository:
 
-    $ just list-todos
+    ``` bash
+    just list-todos
+    ```
 
 # Questions:
-package_github_repo:
-  type: str
-  help: "What is or will be the GitHub repository spec for the project?"
-  placeholder: "user/repo"
-  validator: |
-    {% if package_github_repo and not (package_github_repo | regex_search('^[\w.-]+\/[\w.-]+$')) %}
-    Must be in the format `user/repo` and contain only alphanumeric characters and `_`, `-`, or `.`.
-    {% endif %}
+is_seedcase_project:
+  type: bool
+  help: "Is this package part of the Seedcase Project?"
+  default: true
 
-github_user:
+github_repo:
   type: str
-  default: "{{ package_github_repo.split('/')[0] if package_github_repo else '' }}"
+  default: "{{ _copier_conf.dst_path | realpath | basename }}"
   when: false
 
-package_name:
+github_user:
   type: str
-  help: "What is the name of the package?"
-  default: "{{ _copier_conf.dst_path | basename }}"
-  validator: |
-    {% if package_name and not (package_name | regex_search('^[\w.-]+$')) %}
-    Must contain only alphanumeric characters and `_`, `-`, or `.`.
-    {% endif %}
+  help: "What is the name of the GitHub user or organisation where the repository will be or is stored?"
+  default: "{{ 'seedcase-project' if is_seedcase_project else '' }}"
 
-package_name_snake_case:
+hosting_provider:
   type: str
-  default: "{{package_name | replace('-', '_') | replace('.', '_')}}"
-  when: false
-
-is_seedcase_project:
-  type: bool
-  help: "Is this package part of the Seedcase Project?"
-  default: "{{ github_user == 'seedcase-project' }}"
+  help: "What hosting provider will you use for the documentation website?"
+  choices:
+    - netlify
+    - gh-pages
 
 homepage:
   type: str
   help: "What is the homepage of your project?"
-  default: "{{ 'https://%s.seedcase-project.org' % package_name if is_seedcase_project else '' }}"
+  default: "{{ 'https://%s.seedcase-project.org' % github_repo if is_seedcase_project else '' }}"
 
 author_given_name:
   type: str
@@ -103,6 +102,16 @@ github_board_number:
     The board number must be an integer.
     {% endif %}
 
+github_repo_snake_case:
+  type: str
+  default: "{{github_repo | replace('-', '_') | replace('.', '_')}}"
+  when: false
+
+github_repo_spec:
+  type: str
+  default: "{{ github_user }}/{{ github_repo }}"
+  when: false
+
 copyright_year:
   type: str
   default: "{{ copyright_year | default('%Y' | strftime) }}"

justfile

@@ -3,7 +3,7 @@
 
 @_checks: check-spelling check-commits
 # Test Seedcase and non-Seedcase projects
-@_tests: (test "true") (test "false")
+@_tests: (test "true" "netlify") (test "false" "netlify") (test "true" "gh-pages") (test "false" "gh-pages")
 @_builds: build-contributors build-website build-readme
 
 # Run all build-related recipes in the justfile
@@ -47,10 +47,10 @@ check-commits:
 check-spelling:
   uvx typos
 
-# Test and check that a Python package can be created from the template
-test is_seedcase_project:
+# Test that a Python package can be created from the template, with parameters for: `is_seedcase_project` (true or false) and `hosting_provider` (either "gh-pages" or "netlify")
+test is_seedcase_project="true" hosting_provider="netlify":
   #!/usr/bin/env bash
-  test_name="test-python-package"
+  test_name="test-package-{{ hosting_provider }}"
   test_dir="$(pwd)/_temp/{{ is_seedcase_project }}/$test_name"
   template_dir="$(pwd)"
   commit=$(git rev-parse HEAD)
@@ -60,8 +60,9 @@ test is_seedcase_project:
     --vcs-ref=$commit \
     --defaults \
     --trust \
-    --data package_github_repo="first-last/repo" \
     --data is_seedcase_project={{ is_seedcase_project }} \
+    --data hosting_provider={{ hosting_provider }} \
+    --data github_user="first-last" \
     --data author_given_name="First" \
     --data author_family_name="Last" \
     --data author_email="[email protected]" \
@@ -94,8 +95,9 @@ test is_seedcase_project:
     --defaults \
     --trust \
     --overwrite \
-    --data package_github_repo="first-last/repo" \
     --data is_seedcase_project={{ is_seedcase_project }} \
+    --data hosting_provider={{ hosting_provider }} \
+    --data github_user="first-last" \
     --data author_given_name="First" \
     --data author_family_name="Last" \
     --data author_email="[email protected]" \

template/.github/workflows/build-website.yml

@@ -0,0 +1,26 @@
+name: Build website
+
+on:
+  push:
+    branches:
+      - main
+
+# Limit token permissions for security
+permissions: read-all
+
+jobs:
+  build-website:
+    uses: seedcase-project/.github/.github/workflows/reusable-build-docs-with-python.yml@main
+    {%- if hosting_provider == 'gh-pages' %}
+    with:
+      hosting-provider: gh-pages
+    permissions:
+      contents: write
+      pages: write
+    {%- endif %}
+    secrets:
+      {% if hosting_provider == 'gh-pages' -%}
+      github-token: {{ '${{ secrets.GITHUB_TOKEN }}' }}
+      {%- elif hosting_provider == 'netlify' -%}
+      netlify-token: {{ '${{ secrets.NETLIFY_AUTH_TOKEN }}' }}
+      {%- endif %}

template/.github/workflows/build-website.yml.jinja

@@ -20,5 +20,5 @@ keywords:
   - ""
 license: MIT
 message: "If you use this Python package, please cite it using these metadata."
-repository-code: "https://github.com/{{ package_github_repo }}"
+repository-code: "https://github.com/{{ github_repo_spec }}"
 url: "{{ homepage }}"

template/CITATION.cff.jinja

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) {{ copyright_year }} {{ package_name }} authors
+Copyright (c) {{ copyright_year }} {{ github_repo }} authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

template/LICENSE.md.jinja

@@ -11,19 +11,24 @@ project:
 website:
   # TODO: Fill in the title of the website.
   title: ""
+  {% if hosting_provider == "gh-pages" -%}
+  site-url: "https://{{ github_user }}.github.io/{{ github_repo }}/"
+  {%- elif hosting_provider == "netlify" -%}
+  # TODO: Set the Netlify custom domain URL
   site-url: "{{ homepage }}"
-  repo-url: "https://github.com/{{ package_github_repo }}"
+  {%- endif %}
+  repo-url: "https://github.com/{{ github_repo_spec }}"
   page-navigation: true
   navbar:
     pinned: true
     title: false
     {%- if is_seedcase_project %}
-    logo: "_extensions/seedcase-project/seedcase-theme/logos/navbar-logo-{{ package_name }}.svg"
-    logo-alt: "{{ package_name }} logo: Main page"
+    logo: "_extensions/seedcase-project/seedcase-theme/logos/navbar-logo-{{ github_repo }}.svg"
+    logo-alt: "{{ github_repo }} logo: Main page"
     {%- else %}
     # TODO: add logo
     logo: ""
-    logo-alt: "{{ package_name }} logo: Main page"
+    logo-alt: "{{ github_repo }} logo: Main page"
     {%- endif %}
     left:
       - text: "Guide"
@@ -32,7 +37,7 @@ website:
         href: docs/design/index.qmd
     tools:
       - icon: github
-        href: "https://github.com/{{ package_github_repo }}"
+        href: "https://github.com/{{ github_repo_spec }}"
         aria-label: "GitHub icon: Source code"
       {%- if is_seedcase_project %}
       - icon: house
@@ -55,7 +60,7 @@ quartodoc:
   sidebar: "docs/reference/_sidebar.yml"
   style: "pkgdown"
   dir: "docs/reference"
-  package: "{{ package_name_snake_case }}"
+  package: "{{ github_repo_snake_case }}"
   parser: google
   dynamic: true
   renderer: