feat: ✨ add hosting provider variable (#153)

# Description

This PR adds the `hosting_provider` copier variable. Moved from #140 .

Closes #119 

This PR needs a medium-depth review.

## Checklist

- [x] Added or updated tests
- [x] Updated documentation
- [x] Ran `just run-all`

Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>

Author: martonvago

copier.yaml

@@ -65,6 +65,13 @@ github_user:
   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 '' }}"
 
+hosting_provider:
+  type: str
+  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?"

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)
@@ -61,6 +61,7 @@ test is_seedcase_project:
     --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" \
@@ -95,6 +96,7 @@ test is_seedcase_project:
     --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" \

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

@@ -11,7 +11,12 @@ 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 }}"
+  {%- endif %}
   repo-url: "https://github.com/{{ github_repo_spec }}"
   page-navigation: true
   navbar:

template/_publish.yml

@@ -0,0 +1,5 @@
+- source: project
+  netlify:
+    # TODO: Include correct ID and URL
+    - id: ""
+      url: "https://{{ github_user }}-{{ github_repo }}.netlify.app"