build: Use template files for creating extensions; Publish website (#16)

Author: schloerke

.github/workflows/website.yaml

@@ -0,0 +1,48 @@
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - docs-**
+  pull_request:
+
+name: Website
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Render Quarto Project
+        uses: quarto-dev/quarto-actions/render@v2
+
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site/
+
+  deploy:
+    if: github.event_name == 'push'
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Makefile

@@ -0,0 +1,69 @@
+.DEFAULT_GOAL := help
+
+# Shell settings
+SHELL := /bin/bash
+
+# Use an empty target to force running every time
+.PHONY: FORCE
+FORCE:
+
+# Quarto
+docs: FORCE ## [docs] Generate documentation
+	@echo "📖 Generating documentation"
+	quarto render
+docs-preview: FORCE ## [docs] Watch documentation
+	@echo "📖 Watching documentation"
+	quarto preview
+
+# Creating extensions
+DIR:=
+create-extension:  ## [ext] Create extension folder
+	@if [ -z "$(DIR)" ]; then \
+		echo 'Please provide a directory name using `make create-extension DIR="my_dir"'; \
+		exit 1; \
+	fi
+	@# If the directory contains a slash, error
+	@if echo $(DIR) | grep -q '/'; then \
+		echo 'Please provide a directory name without a slash'; \
+		exit 1; \
+	fi
+	@# If the directory already exists, error
+	@if [ -d "extensions/$(DIR)" ]; then \
+		echo 'Directory "extensions/$(DIR)" already exists'; \
+		exit 1; \
+	fi
+
+	@echo "🔧 Creating directory: extensions/$(DIR)"
+	@mkdir -p "extensions/$(DIR)"
+
+	@echo "📝 Copying template files: $(ls -m _template)"
+	@cp -r _template/* extensions/$(DIR)
+
+	@echo ""
+	@echo "⏳ Remaining Tasks:"
+	@echo "- [ ] Copy in app files"
+	@echo "- [ ] Create manifest.json"
+
+
+# build: FORCE   ## [py] Build python package
+# 	@echo "🧳 Building python package"
+# 	@[ -d dist ] && rm -r dist || true
+# 	uv build
+
+
+
+help: FORCE  ## Show help messages for make targets
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; { \
+		printf "\033[32m%-18s\033[0m", $$1; \
+		if ($$2 ~ /^\[docs\]/) { \
+			printf "\033[34m[docs]\033[0m%s\n", substr($$2, 7); \
+		} else if ($$2 ~ /^\[py\]/) { \
+			printf "  \033[33m[py]\033[0m%s\n", substr($$2, 5); \
+		} else if ($$2 ~ /^\[ext\]/) { \
+			printf " \033[35m[ext]\033[0m%s\n", substr($$2, 6); \
+		} else if ($$2 ~ /^\[r\]/) { \
+			printf "   \033[31m[r]\033[0m%s\n", substr($$2, 4); \
+		} else { \
+			printf "       %s\n", $$2; \
+		} \
+	}'

_template/connect-extension.qmd

@@ -0,0 +1,8 @@
+connect-extension.toml
+---
+title: extension title
+categories:
+    -
+---
+
+extension description

_template/connect-extension.toml

@@ -0,0 +1,4 @@
+name = "<extension-name>"
+title = "<extension-title>"
+description = "<extension-categories>"
+access_type = "logged_in|acl"

contributing.qmd

@@ -3,34 +3,29 @@ title: Contributing
 ---
 
 Add your extension in the `extensions/` subdirectory.
-In addition to the extension code, include:
 
-## `connect-extension.qmd`
+To help you get started, call `make create-extension DIR=my_extension_name` to create a new extension directory with the necessary files. Note, you will need to manually create your `manifest.json` file.
 
-A file that has the name of your extension, the categories it falls into, and a brief description
+<br />
 
-```{filename="connect-extension.qmd"}
----
-title: extension title
-categories:
-    -
----
+## Required files
+
+### `manifest.json`
+
+Use `rsconnect` or `rsconnect-python` to generate a manifest, which is required as part of the extension bundle
 
-extension description
+### `connect-extension.qmd`
 
+A file that has the name of your extension, the categories it falls into, and a brief description
+
+```{filename="connect-extension.qmd"}
+{{< include _template/connect-extension.qmd >}}
 ```
 
-## `connect-extension.toml`
+### `connect-extension.toml`
 
 A file with the name, title, a brief description of the extension, and the access type it should have on being created
 
 ```{filename="connect-extension.toml"}
-name = "<extension-name>"
-title = "<extension-title>"
-description = "<extension-categories>"
-access_type = "logged_in|acl"
+{{< include _template/connect-extension.toml >}}
 ```
-
-## `manifest.json`
-
-Use `rsconnect` or `rsconnect-python` to generate a manifest, which is required as part of the extension bundle