Merge pull request #36 from USI-FMAA/copilot/fix-35

Add GitHub Actions release workflow for automated releases

Author: WeiTing1991

.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags (v0.1.0, v1.0.0, etc.)
+
+permissions:
+  contents: write  # Required to create releases
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch full history for tags
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras --dev
+      
+      - name: Install GitHub CLI
+        run: |
+          type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y)
+          curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
+          && sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
+          && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
+          && sudo apt update \
+          && sudo apt install gh -y
+      
+      - name: Build package
+        run: |
+          uv run invoke build
+      
+      - name: Create GitHub Release and Upload Assets
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          # Extract tag name
+          TAG_NAME=${GITHUB_REF#refs/tags/}
+          echo "Creating release for tag: $TAG_NAME"
+          
+          # Use the existing gh_release task from tasks.py
+          uv run invoke gh_release
+          
+          # Upload built packages to the release
+          gh release upload "$TAG_NAME" dist/*.whl dist/*.tar.gz --clobber

CONTRIBUTING.md

@@ -39,8 +39,35 @@ command line to ease recurring operations:
 * `invoke check`: Run various code and documentation style checks.
 * `invoke docs`: Generate documentation.
 * `invoke test`: Run all tests and checks in one swift command.
+* `invoke build`: Build the package for distribution.
+* `invoke build-release`: Build a release with automatic version bumping and tagging.
+* `invoke gh-release`: Create GitHub release using GitHub CLI - automatically detects tag.
 * `invoke`: Show available tasks.
 
+## Releases
+
+Releases are automated via GitHub Actions. To create a new release:
+
+1. **Manual Release Process**:
+   ```bash
+   # Bump version and create tag (patch/minor/major)
+   invoke build-release --part=patch
+   
+   # Push tags to trigger automated release
+   git push origin --tags
+   ```
+
+2. **Automated Release Process**:
+   - The GitHub Actions workflow (`.github/workflows/release.yml`) automatically triggers on tag pushes
+   - Builds the package using `uv build`
+   - Creates a GitHub release with changelog notes using `invoke gh-release`
+   - Uploads wheel and source distribution as release assets
+
+3. **Release Artifacts**:
+   - Python wheel (`.whl`)
+   - Source distribution (`.tar.gz`)
+   - Automated release notes from changelog
+
 ## Bug reports
 
 When [reporting a bug](https://github.com/USI-FMAA/dcs/issues) please include: