✨ feat: add support for GitHub Actions

Author: bassemkaroui

README.md

@@ -13,7 +13,6 @@ A modern, batteries‑included [Copier](https://github.com/copier-org/copier) te
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![GitHub](https://img.shields.io/github/license/bassemkaroui/python-template-uv)](https://github.com/bassemkaroui/python-template-uv/blob/main/LICENSE)
 
-
 </div>
 
 ## 🚀 Features
@@ -26,39 +25,55 @@ A modern, batteries‑included [Copier](https://github.com/copier-org/copier) te
   Simply run tasks with `make <task>` (e.g. `make check`, `make docs`).
 
 - **Quality & standards**
+
   - **Formatting** and **Linting**: [Ruff](https://github.com/astral-sh/ruff) ➜ `make format` & `make check-quality`
   - **Type checking**: [Mypy](https://github.com/python/mypy) ➜ `make check-types`
   - **Pre-commit hooks**: [pre-commit](https://pre-commit.com/)
 
 - **Testing & coverage**
+
   - [**pytest**](https://github.com/pytest-dev/pytest) ➜ `make test`
   - [**Coverage**](https://github.com/nedbat/coveragepy) (text, HTML, XML) ➜ `make coverage`
   - Compatibility testing for multiple versions of Python with [**Tox**](https://github.com/tox-dev/tox) and its plugin [tox-uv](https://github.com/tox-dev/tox-uv) ➜ `make tox`
 
 - **Documentation**
+
   - [**MkDocs**](https://github.com/mkdocs/mkdocs) with [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme
   - Live server: `make docs` (serves on localhost:8080)
   - Deploy to GitHub Pages: `make docs-deploy`
 
 - **Release & changelog**
+
   - [Conventional Commits](https://www.conventionalcommits.org/) + [Commitizen](https://github.com/commitizen-tools/commitizen) + [gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji)
   - Automated `CHANGELOG.md` updates
   - Release new versions ➜ `make release`
 
-
 - **Docker & Docker Compose**
+
   - Generate `Dockerfile` + `compose.yml` for local development and deployment (GPU support)
   - Docker targets: `make docker-build`, `make docker-start`, `make docker-stop`
 
 - **Optional tooling**
+
   - Typer CLI scaffold
   - Strict typing
   - Run tests with parallel execution via pytest-xdist
   - Preconfigured dependency categories (ML, data, web, etc.)
 
-- **Future CI support**:
-  CI workflows are scaffolded for upcoming releases.
+- **CI/CD Workflows**
 
+  This template includes GitHub Actions workflows for continuous integration, testing, and release automation:
+
+  - **PR Commenting** (`pr-thank-you.yaml`): Posts a fun GIPHY comment on new pull requests using [`docker-action-pr-giphy-comment`](https://github.com/bassemkaroui/docker-action-pr-giphy-comment)
+
+  - **CI/CD Pipeline** (`main.yaml.jinja`):
+    - **Checks**: Linting (Ruff), type checking (Mypy), documentation build.
+    - **Tests**: Runs `pytest` across supported Python versions using a matrix strategy.
+    - **Releases**: Automatically publishes releases when a Git tag is pushed.
+    - **Docs Deployment**: Deploys MkDocs documentation to GitHub Pages.
+    - **Package Publishing** (optional): Publishes the package to PyPI if `publish_to_pypi` is enabled and `PYPI_TOKEN` is set.
+
+  These workflows are generated into `.github/workflows/` in the scaffolded project. You can customize them further as needed.
 
 ## 🛠 Prerequisites
 
@@ -67,7 +82,6 @@ A modern, batteries‑included [Copier](https://github.com/copier-org/copier) te
 - **copier-templates-extensions** ≥ 0.3.1
 - **uv** (if not installed check [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/))
 
-
 ## 🎉 Quickstart
 
 ```bash
@@ -101,6 +115,7 @@ make check   # runs all checks: lint, types, docs build, API, etc.
 ```
 
 **Stay up to date**
+
 ```bash
 cd /path/to/my-project
 
@@ -110,7 +125,6 @@ uvx copier update --trust --exclude src/ --exclude tests/ .
 > [!WARNING]
 > To be able to [update your project](https://copier.readthedocs.io/en/stable/updating/), do not delete or manually modify the generated `.copier-answers.yml` file.
 
-
 ## 📋 Available Duties
 
 All tasks are defined in `duties.py` and exposed through `make`. Common duties include:
@@ -143,33 +157,31 @@ tox                        Run tests across multiple Python versions.
 
 For the full list and details, see [duties.py](https://github.com/bassemkaroui/python-template-uv/blob/main/template/duties.py.jinja).
 
-
 ## 🔧 Template Variables
 
 When running `copier`, you’ll be prompted for:
 
-| Variable                   | Description                                                      | Default            |
-| -------------------------- | ---------------------------------------------------------------- | ------------------ |
-| `project_name`             | Your project’s **name** (lowercase, letters/digits/dashes)       | *—*                |
-| `project_description`      | A short summary of what your project does                        | *—*                |
-| `author_fullname`          | Your full name                                                   | from `git`         |
-| `author_email`             | Your email address                                               | from `git`         |
-| `repository_provider`      | Where you host your repo (`github` or `other`)                   | `github`           |
-| `homepage`                 | Project homepage URL                                             | `https://<user>.github.io/<proj>` |
-| `python_version`           | Default Python interpreter for development                       | `3.12`             |
-| `min_python_version`       | Minimum supported Python version                                  | `3.10`             |
-| `with_typer_cli`           | Include a Typer CLI scaffold?                                     | `false`            |
-| `with_strict_typing`       | Enable strict typing enforcement?                                 | `false`            |
-| `tox`                      | Include Tox configuration?                                        | `true`             |
-| `coverage_threshold`       | Minimum test coverage %                                           | `100`              |
-| `with_conventional_commits`| Enforce Conventional Commits?                                     | `true`             |
-| `cz_gitmoji`               | Include emojis in commit messages?                               | `true`             |
-| `dockerfile`               | Generate Dockerfile and Compose file?                             | `true`             |
-| `gpus`                     | Enable GPU support in Docker builds?                              | `false`            |
+| Variable                    | Description                                                | Default                           |
+| --------------------------- | ---------------------------------------------------------- | --------------------------------- |
+| `project_name`              | Your project’s **name** (lowercase, letters/digits/dashes) | _—_                               |
+| `project_description`       | A short summary of what your project does                  | _—_                               |
+| `author_fullname`           | Your full name                                             | from `git`                        |
+| `author_email`              | Your email address                                         | from `git`                        |
+| `repository_provider`       | Where you host your repo (`github` or `other`)             | `github`                          |
+| `homepage`                  | Project homepage URL                                       | `https://<user>.github.io/<proj>` |
+| `python_version`            | Default Python interpreter for development                 | `3.12`                            |
+| `min_python_version`        | Minimum supported Python version                           | `3.10`                            |
+| `with_typer_cli`            | Include a Typer CLI scaffold?                              | `false`                           |
+| `with_strict_typing`        | Enable strict typing enforcement?                          | `false`                           |
+| `tox`                       | Include Tox configuration?                                 | `true`                            |
+| `coverage_threshold`        | Minimum test coverage %                                    | `100`                             |
+| `with_conventional_commits` | Enforce Conventional Commits?                              | `true`                            |
+| `cz_gitmoji`                | Include emojis in commit messages?                         | `true`                            |
+| `dockerfile`                | Generate Dockerfile and Compose file?                      | `true`                            |
+| `gpus`                      | Enable GPU support in Docker builds?                       | `false`                           |
 
 > See the full list in [copier.yaml](https://github.com/bassemkaroui/python-template-uv/blob/main/copier.yaml).
 
-
 ## 📄 License
 
 This project is released under the **MIT License**. See [LICENSE](https://github.com/bassemkaroui/python-template-uv/blob/main/LICENSE) for details.

template/README.md.jinja

@@ -12,6 +12,7 @@
 {%- endif %}
 {%- if repository_provider == 'github' %}
 [![Release](https://img.shields.io/github/v/release/{{ author_github_handle }}/{{ project_name }})](https://github.com/{{ author_github_handle }}/{{ project_name }}/releases)
+[![CI/CD Pipeline](https://github.com/{{ author_github_handle }}/{{ project_name }}/actions/workflows/main.yaml/badge.svg)](https://github.com/{{ author_github_handle }}/{{ project_name }}/actions/workflows/main.yaml)
 [![Commit activity](https://img.shields.io/github/commit-activity/m/{{ author_github_handle }}/{{ project_name }})](https://github.com/{{ author_github_handle }}/{{ project_name }}/commits)
 [![GitHub](https://img.shields.io/github/license/{{ author_github_handle }}/{{ project_name }})](https://github.com/{{ author_github_handle }}/{{ project_name }}/blob/main/LICENSE)
 {%- endif %}

template/{% if repository_provider == 'github' %}.github{% endif %}/actions/setup-env/action.yaml

@@ -0,0 +1,22 @@
+name: 'Setup UV & Python'
+description: 'Checks out the repo, sets up `uv`, and installs the right Python version (supports file or literal).'
+inputs:
+  python-version:
+    description: 'Literal Python version (e.g. "3.12")'
+    required: false
+  python-version-file:
+    description: 'Path to a .python-version file'
+    required: false
+
+runs:
+  using: composite
+  steps:
+    - name: Setup uv
+      uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca # v6
+
+    - name: Setup Python
+      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+      with:
+        # one of these two
+        python-version: ${{ inputs.python-version }}
+        python-version-file: ${{ inputs.python-version-file }}

template/{% if repository_provider == 'github' %}.github{% endif %}/workflows/main.yaml.jinja

@@ -0,0 +1,162 @@
+name: CI
+
+concurrency:
+  group: {% raw %}${{ github.workflow }}-${{ github.ref }}{% endraw %}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+  workflow_dispatch:
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Setup env
+        uses: ./.github/actions/setup-env
+        with:
+          python-version-file: ".python-version"
+
+      - name: Check the code quality with Ruff
+        run: make check-quality
+
+      - name: Check typing
+        run: make check-types
+
+      - name: Check if the documentation builds correctly
+        run: make check-docs
+
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+{%- set start = min_python_version.split('.')[-1] | int %}
+{%- set majors = range(start, 14) %}
+{%- for minor in majors %}
+          - "3.{{ minor }}"
+{%- endfor %}
+      fail-fast: false
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Setup env
+        uses: ./.github/actions/setup-env
+        with:
+          python-version: {% raw %}${{ matrix.python-version }}{% endraw %}
+
+      - name: Run tests
+        run: make test
+
+  release:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/')
+    needs:
+      - checks
+      - tests
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Setup env
+        uses: ./.github/actions/setup-env
+        with:
+          python-version-file: ".python-version"
+
+      - name: Prepare release notes
+        run: {% raw %}uvx --from commitizen --with cz-conventional-gitmoji cz changelog ${{ github.ref_name }} --file-name release-notes.md && echo ${{ github.ref }}{% endraw %}
+
+      - name: Create release
+        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2
+        with:
+          body_path: release-notes.md
+          prerelease: {% raw %}${{ contains(github.ref_name, 'rc') || contains(github.ref_name, 'b') || contains(github.ref_name, 'a') }}{% endraw %}
+
+  deploy-docs:
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/'))
+    runs-on: ubuntu-latest
+    needs:
+      - checks
+      - tests
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Setup env
+        uses: ./.github/actions/setup-env
+        with:
+          python-version-file: ".python-version"
+
+      - name: Build docs
+        run: uv run mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@e9c66a37f080288a11235e32cbe2dc5fb3a679cc # v4
+        with:
+          github_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
+          publish_dir: ./site
+  {%- if publish_to_pypi %}
+
+  publish-package:
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/'))
+    runs-on: ubuntu-latest
+    needs:
+      - checks
+      - tests
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Setup env
+        uses: ./.github/actions/setup-env
+        with:
+          python-version-file: ".python-version"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        if: secrets.PYPI_TOKEN != ''
+        env:
+          UV_PUBLISH_TOKEN: {% raw %}${{ secrets.PYPI_TOKEN }}{% endraw %}
+        run: uv publish
+  {%- endif %}

template/{% if repository_provider == 'github' %}.github{% endif %}/workflows/pr-thank-you.yaml

@@ -0,0 +1,21 @@
+on:
+  pull_request:
+    types:
+    - opened
+
+jobs:
+  pr-action:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+    - name: Post PR Comment
+      id: giphy
+      uses: bassemkaroui/docker-action-pr-giphy-comment@v1
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        giphy-api-key: ${{ secrets.GIPHY_API_KEY }}
+
+    - name: Log Comment URL
+      run: echo "URL - ${{ steps.giphy.outputs.pr-comment-url }}"