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

Author: lwjohnst86

docs/guide.qmd

@@ -42,10 +42,15 @@ First, open a Terminal and move into the directory where you want to
 create the new Python package. Then run the following command:
 
 ``` bash
-# Copy into the current directory, which is the "."
-uvx copier copy --trust gh:seedcase-project/template-python-package .
+uvx copier copy --trust gh:seedcase-project/template-python-package new-package
 ```
 
+Here, `new-package` is the name of the new folder you will create from
+the template. The template assumes that the name of your new folder will
+also be the name of the GitHub repository for the Python package. So the
+new folder name should be a short, lowercase name without spaces or
+special characters.
+
 ::: callout-caution
 This template runs some post-copy commands using your terminal. In order
 to run them, you need to use the `--trust` option. Review the
@@ -64,12 +69,13 @@ to the existing package. This will add all the template's files and
 configurations to the existing package.
 
 ``` bash
-uvx copier copy --trust gh:seedcase-project/template-python-package .
+uvx copier copy --trust gh:seedcase-project/template-python-package new-package
 ```
 
-It will go through a series of prompts, as in the case of creating a new
-Python package, including asking if you want to overwrite existing
-files.
+See the comment above in the "Creating a new Python package" section
+about naming the new folder. It will go through a series of prompts, as
+in the case of creating a new Python package, including asking if you
+want to overwrite existing files.
 
 ::: callout-note
 To use the `copy` command, the Python package needs to be tracked by Git
@@ -129,8 +135,8 @@ just install-precommit
 This sets up the pre-commit hooks to run standard checks on your
 repository whenever you commit files to the history.
 
-If you are using the template to create a Python package for the Seedcase
-Project, run:
+If you are using the template to create a Python package for the
+Seedcase Project, run:
 
 ``` bash
 just update-quarto-theme
@@ -140,9 +146,9 @@ Then set `seedcase-theme` as your project `type` in `_quarto.yml`.
 
 This adds the `seedcase-theme` Quarto theme to the website, which
 provides a consistent look and feel across all Seedcase Project
-websites, including for Python package websites.
-It's called `update-quarto-theme` here since you can use this
-command to keep the theme updated.
+websites, including for Python package websites. It's called
+`update-quarto-theme` here since you can use this command to keep the
+theme updated.
 
 Next, install [`spaid`](https://github.com/seedcase-project/spaid) and
 use the following commands to run the next setup steps:
@@ -175,5 +181,5 @@ additional setup are:
     GitHub App, along with the `ADD_TO_BOARD_TOKEN` secret and the
     `ADD_TO_BOARD_APP_ID` variable of the GitHub App's ID.
 
-If you use Netlify, you will also need to add a `NETLIFY_AUTH_TOKEN` secret
-of your Netlify Token.
+If you use Netlify, you will also need to add a `NETLIFY_AUTH_TOKEN`
+secret of your Netlify Token.

docs/includes/_badges.qmd

@@ -1,5 +1,5 @@
 <!-- [![DOI]()]() -->
-[![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)](https://github.com/copier-org/copier)
+[![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)
 [![Build website](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml/badge.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml)

justfile

@@ -49,60 +49,7 @@ check-spelling:
 
 # 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-package-{{ hosting_provider }}"
-  test_dir="$(pwd)/_temp/{{ is_seedcase_project }}/$test_name"
-  template_dir="$(pwd)"
-  commit=$(git rev-parse HEAD)
-  rm -rf $test_dir
-  # vcs-ref means the current commit/head, not a tag.
-  uvx copier copy $template_dir $test_dir \
-    --vcs-ref=$commit \
-    --defaults \
-    --trust \
-    --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]" \
-    --data review_team="@first-last/developers" \
-    --data github_board_number=22
-  # Run checks in the generated test Python package
-  cd $test_dir
-  git add .
-  git commit -m "test: initial copy"
-  just check-python check-spelling
-  # TODO: Find some way to test the `update` command
-  # Check that recopy works
-  echo "Testing recopy command -----------"
-  rm .cz.toml
-  git add .
-  git commit -m "test: preparing to recopy from the template"
-  uvx copier recopy \
-    --vcs-ref=$commit \
-    --defaults \
-    --overwrite \
-    --trust
-  # Check that copying onto an existing Python package works
-  echo "Using the template in an existing package command -----------"
-  rm .cz.toml .copier-answers.yml LICENSE.md
-  git add .
-  git commit -m "test: preparing to copy onto an existing package"
-  uvx copier copy \
-    $template_dir $test_dir \
-    --vcs-ref=$commit \
-    --defaults \
-    --trust \
-    --overwrite \
-    --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]" \
-    --data review_team="@first-last/developers" \
-    --data github_board_number=22
+  sh ./test-template.sh {{ is_seedcase_project }} {{ hosting_provider }}
 
 # Clean up any leftover and temporary build files
 cleanup:

template/docs/includes/_badges.qmd

@@ -1,12 +1,12 @@
 <!-- TODO: Include DOI after uploading -->
-<!-- [![PyPI Version](https://img.shields.io/pypi/v/{{< meta gh.repo >}})](https://pypi.org/project/{{< meta gh.repo >}}/) -->
-[![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)](https://github.com/copier-org/copier)
-[![Supported Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/refs/heads/main/pyproject.toml)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/blob/main/pyproject.toml)
+<!-- [![PyPI Version](https://img.shields.io/pypi/v/{{< meta gh.repo >}}.svg)](https://pypi.org/project/{{< meta gh.repo >}}/) -->
+[![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)
+[![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2F{{< meta gh.org >}}%2F{{< meta gh.repo >}}%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/blob/main/pyproject.toml)
 [![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)
 [![Build documentation](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml/badge.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml)
 [![Build package](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-package.yml/badge.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-package.yml)
-[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/badge?raw=true)](https://scorecard.dev/viewer/?uri=github.com/{{< meta gh.org >}}/{{< meta gh.repo >}})
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/badge?raw=true.svg)](https://scorecard.dev/viewer/?uri=github.com/{{< meta gh.org >}}/{{< meta gh.repo >}})
 [![CodeQL](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/github-code-scanning/codeql)
 [![code coverage](https://raw.githubusercontent.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/coverage/coverage.svg?raw=true)](https://htmlpreview.github.io/?https://raw.githubusercontent.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/coverage/index.html)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/{{< meta gh.org >}}/{{< meta gh.repo >}}/main.svg)](https://results.pre-commit.ci/latest/github/{{< meta gh.org >}}/{{< meta gh.repo >}}/main)

test-template.sh

@@ -0,0 +1,82 @@
+#!/usr/bin/env bash
+
+# Needs two arguments:
+#
+# 1. is_seedcase_project: true or false
+# 2. hosting_provider: e.g., "github", "gitlab", etc.
+
+# Argument naming -----
+is_seedcase_project="${1}"
+hosting_provider="${2}"
+
+if [ -z "$is_seedcase_project" ] || [ -z "$hosting_provider" ]; then
+  echo "Usage: sh $0 <is_seedcase_project> <hosting_provider>"
+  echo "Example: sh $0 true netlify"
+  exit 1
+fi
+
+# Set up variables and functions for the test -----
+test_name="test-package-$hosting_provider"
+test_dir="$(pwd)/_temp/$is_seedcase_project/$test_name"
+template_dir="$(pwd)"
+# Use the latest commit for the template
+commit=$(git rev-parse HEAD)
+
+# Needs three arguments:
+#
+# 1. Template directory
+# 2. Destination directory
+# 3. VCS ref (commit, branch, tag, etc.)
+copy () {
+  # vcs-ref means the current commit/head, not a tag.
+  uvx copier copy $1 $2 \
+    --vcs-ref=$3 \
+    --defaults \
+    --data is_seedcase_project=$is_seedcase_project \
+    --data github_user="first-last" \
+    --data hosting_provider=$hosting_provider \
+    --data author_given_name="First" \
+    --data author_family_name="Last" \
+    --data author_email="[email protected]" \
+    --data review_team="@first-last/developers" \
+    --data github_board_number=22 \
+    --overwrite \
+    --skip-tasks \
+    --trust
+}
+
+# Pre-test setup -----
+# Remove the leftover directory from previous runs
+rm -rf $test_dir
+mkdir -p $test_dir
+
+# Check initial creation -----
+# TODO: Find some way to test the `update` command
+# Any step that fails will exit the script with an error and not continue
+echo "Testing copy for new projects when: 'is_seedcase_project'='$is_seedcase_project', 'hosting_provider'='$hosting_provider' -----------"
+(
+  cd $test_dir &&
+    copy $template_dir $test_dir $commit &&
+    git init -b main &&
+    git add . &&
+    git commit --quiet -m "test: initial copy" &&
+    # Check that recopy works -----
+    echo "Testing recopy when: 'is_seedcase_project'='$$is_seedcase_project', 'hosting_provider'='$hosting_provider' -----------" &&
+    rm .cz.toml &&
+    git add . &&
+    git commit --quiet -m "test: preparing to recopy from the template" &&
+    uvx copier recopy \
+      --vcs-ref=$commit \
+      --defaults \
+      --overwrite \
+      --skip-tasks \
+      --trust &&
+    # Check that copying onto an existing package works -----
+    echo "Testing copy in existing projects when: 'is_seedcase_project'='$is_seedcase_project', 'hosting_provider'='$hosting_provider' -----------" &&
+    rm .cz.toml .copier-answers.yml &&
+    git add . &&
+    git commit --quiet -m "test: preparing to copy onto an existing package" &&
+    copy $template_dir $test_dir $commit #&&
+    # Checks and builds -----
+    # just run-all
+)