feat: add ci for template

Author: dzhang32

cookiecutter.json

@@ -5,5 +5,7 @@
     "description": "What's the main goal of this package?",
     "python_version": "3.13",
     "year": "2025",
-    "include_cli": "y"
+    "include_cli": "y",
+    "include_docs": "y",
+    "include_pypi": "y"
 }

{{cookiecutter.package_name}}/.github/actions/setup/action.yml

@@ -0,0 +1,25 @@
+name: 'Setup Python Environment'
+description: 'Setup Python and install project dependencies.'
+author: 'David Zhang'
+
+inputs:
+  python-version:
+    description: 'Python version to use'
+    required: true
+  dependencies:
+    description: 'Dependency group to install (e.g., "dev", "docs", "build")'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python ${{ inputs.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install dependencies
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[${{ inputs.dependencies }}]"

{{cookiecutter.package_name}}/.github/workflows/test_deploy.yml

@@ -0,0 +1,93 @@
+name: test_deploy
+
+on:
+  push:
+    branches: [ main ]
+    tags: [ '*' ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  PYTHON_VERSION: "{{cookiecutter.python_version}}"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python and install dependencies
+        uses: ./.github/actions/setup
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          dependencies: dev
+
+      - name: Run tests
+        run: pytest
+
+  {% if cookiecutter.include_docs == 'y' %}
+  deploy-docs:
+    runs-on: ubuntu-latest
+
+    # Do not run on git tag (i.e. releases).
+    # Only runs if tests pass.
+    if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+    needs: [test]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python and install dependencies
+        uses: ./.github/actions/setup
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          dependencies: docs
+
+      - name: Build documentation
+        run: |
+          cp README.md docs/index.md
+          cp CHANGELOG.md docs/changelog.md
+          # --strict errors on any warnings.
+          # builds the site to ./site.
+          mkdocs build --strict
+
+      - name: Deploy to GitHub Pages
+        # Only trigger on push to main branch.
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+  {% endif %}
+
+  {% if cookiecutter.include_pypi == 'y' %}
+  deploy-pypi:
+    runs-on: ubuntu-latest
+
+    # Only runs on git tag and if tests pass.
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [test]
+
+    # Authenticate for PyPI publishing.
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python and install dependencies
+        uses: ./.github/actions/setup
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          dependencies: build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+  {% endif %}