Files Added

  .github/workflows/
  ├── ci.yml        # Tests on Python 3.10-3.13, lint, format check
  ├── release.yml   # Publish to PyPI on tags (v*)
  └── docs.yml      # Deploy docs to GitHub Pages on push to main

  CONTRIBUTING.md   # Simple dev setup guide

  Workflow Summary
  ┌──────────┬────────────────────────┬──────────────────────────────────────────────┐
  │ Workflow │        Trigger         │                    Action                    │
  ├──────────┼────────────────────────┼──────────────────────────────────────────────┤
  │ CI       │ Push/PR to main        │ Run tests, lint, format check                │
  ├──────────┼────────────────────────┼──────────────────────────────────────────────┤
  │ Release  │ Tag v*                 │ Build & publish to PyPI (trusted publishing) │
  ├──────────┼────────────────────────┼──────────────────────────────────────────────┤
  │ Docs     │ Push to main / release │ Build & deploy to GitHub Pages               │
  └──────────┴────────────────────────┴──────────────────────────────────────────────┘
  Setup Required on GitHub

  1. PyPI Trusted Publishing: Go to PyPI → Your Project → Publishing → Add GitHub as trusted publisher
  2. GitHub Pages: Settings → Pages → Source: "Deploy from a branch" → Branch: gh-pages
  3. Codecov (optional): Add CODECOV_TOKEN secret if you want coverage reports

Author: FBumann

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Format check
+        run: uv run ruff format --check .
+
+      - name: Test
+        run: uv run pytest --cov=xarray_plotly --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.12'
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync --extra docs
+
+      - name: Build docs
+        run: uv run mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing to xarray_plotly
+
+Thanks for your interest in contributing!
+
+## Development Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/felix/xarray_plotly.git
+cd xarray_plotly
+
+# Install with dev dependencies
+uv sync --extra dev
+
+# Install pre-commit hooks
+uv run pre-commit install
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Code Style
+
+We use [ruff](https://github.com/astral-sh/ruff) for linting and formatting. Pre-commit hooks will run automatically, or you can run manually:
+
+```bash
+uv run ruff check --fix .
+uv run ruff format .
+```
+
+## Making Changes
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Make your changes
+4. Run tests (`uv run pytest`)
+5. Commit your changes
+6. Push to your fork and open a Pull Request
+
+## Releases
+
+Releases are automated via GitHub Actions. To create a release:
+
+1. Update version in `pyproject.toml` and `xarray_plotly/__init__.py`
+2. Commit: `git commit -m "Bump version to X.Y.Z"`
+3. Tag: `git tag vX.Y.Z`
+4. Push: `git push && git push --tags`
+
+The CI will automatically publish to PyPI and deploy updated docs.