Merge branch 'major' into beta

Author: bsteubing

.github/workflows/README.md

@@ -0,0 +1,192 @@
+# GitHub Actions Workflows
+
+This document describes the GitHub Actions workflows used in the Activity Browser project.
+
+## Overview
+
+The Activity Browser project uses five GitHub Actions workflows to automate testing, deployment, and project management tasks:
+
+1. **Automated Testing** - Runs tests on every push and PR
+2. **Canary Installation** - Daily installation checks to catch dependency issues
+3. **Beta Deployment** - Publishes beta releases to PyPI and Anaconda
+4. **Stable Release** - Creates releases and publishes to Anaconda
+5. **Milestone Comments** - Automatically notifies users when issues are resolved in releases
+
+---
+
+## 1. Automated Testing (`testing.yaml`)
+
+**Trigger:** Push or pull request to the `major` branch
+
+**Purpose:** Ensures code quality by running the test suite across multiple operating systems and Python versions.
+
+### Matrix Strategy
+- **Operating Systems:** Ubuntu (latest), Windows (latest), macOS 15, macOS (latest)
+- **Python Versions:** 3.10, 3.11, 3.12
+- **Total combinations:** 12 test runs per trigger
+
+### Steps
+1. Checkout code
+2. Set up Python for the specified version
+3. Install Qt libraries (Linux only)
+4. Update pip, setuptools, and wheel
+5. Install package with testing dependencies: `pip install .[testing]`
+6. Run pytest with minimal output: `pytest -s --no-header --no-summary -q`
+
+### Environment
+- Sets `QT_QPA_PLATFORM=offscreen` for headless GUI testing
+- Uses `fail-fast: false` to run all combinations even if some fail
+
+---
+
+## 2. Canary Installation (`install-canary.yaml`)
+
+**Trigger:** Scheduled daily at 7:00 AM UTC (cron: `0 7 * * *`)
+
+**Purpose:** Proactively detects dependency issues by performing fresh installations of Activity Browser from PyPI daily.
+
+### Matrix Strategy
+- **Operating Systems:** Ubuntu (latest), Windows (latest), macOS 15, macOS (latest)
+- **Python Versions:** 3.10, 3.11, 3.12
+- **Timeout:** 12 minutes per job
+
+### Steps
+1. Checkout code
+2. Set up Python
+3. Install activity-browser from PyPI (not from source)
+4. Generate environment info with `pip freeze`
+5. Upload frozen requirements as artifact for each OS/Python combination
+
+### Notes
+- Uses `bash -e {0}` shell to exit on error
+- Helps catch breaking changes in dependencies before users encounter them
+- Artifacts show exact dependency versions that successfully installed
+
+---
+
+## 3. Beta Deployment (`python-package-deploy.yml`)
+
+**Trigger:** Push to `beta` branch or any tag
+
+**Purpose:** Publishes beta versions to PyPI (test and production) and Anaconda Cloud.
+
+### Version Scheme
+- Beta version format: `3.0.0b<N>` where N is the commit count since commit `199b6c3`
+- Calculated dynamically: `git rev-list 199b6c3..HEAD --count`
+
+### Steps
+1. Checkout with full git history (`fetch-depth: "0"`)
+2. Calculate and set version number
+3. Set up Python 3.11
+4. Install `build` package
+5. Build wheel and source distribution
+6. **PyPI Publishing:**
+   - Publish to Test PyPI (with `skip-existing: true`)
+   - Publish to production PyPI
+7. **Conda Publishing:**
+   - Set up Conda environment from `.github/conda-envs/build.yml`
+   - Build Conda package: `conda build -c conda-forge -c cmutel ./recipe/`
+   - Upload to Anaconda Cloud using `CONDA_LCA` secret token
+
+### Permissions
+- Requires `id-token: write` for PyPI trusted publishing
+
+---
+
+## 4. Stable Release (`release.yaml`)
+
+**Trigger:** Push of any git tag
+
+**Purpose:** Creates GitHub releases with auto-generated changelogs and publishes stable versions to Anaconda.
+
+### Steps
+1. Checkout code
+2. **Generate Changelog:**
+   - Uses `mikepenz/release-changelog-builder-action@v4`
+   - Configuration from `.github/changelog-configuration.json`
+   - Builds changelog from PRs with labels
+3. **Create GitHub Release:**
+   - Uses `ncipollo/release-action@v1`
+   - Includes generated changelog as release notes
+   - Targets `main` branch commit
+4. **Build and Upload Conda Package:**
+   - Set up Conda environment (Python 3.11)
+   - Build with `conda build recipe/`
+   - Upload to Anaconda using `CONDA_UPLOAD_TOKEN` secret
+5. **Update Wiki:**
+   - Runs `.github/scripts/update_wiki.sh` to automatically update documentation
+
+### Notes
+- Only runs on tagged commits (version releases)
+- Creates public GitHub releases visible to users
+- Updates project wiki documentation automatically
+
+---
+
+## 5. Milestone Comments (`comment-milestoned-issues.yaml`)
+
+**Trigger:** When a milestone is closed
+
+**Purpose:** Automatically notifies users on closed issues when their issue has been implemented in a release.
+
+### Steps
+1. Uses `actions/github-script@v5` to run JavaScript automation
+2. Gets milestone number and title from the event
+3. Lists all issues associated with the milestone
+4. For each closed issue (not PRs):
+   - Posts a comment with:
+     - Link to the new release
+     - Instructions to update Activity Browser
+     - Link to subscribe to the updates mailing list
+     - Bot disclaimer
+
+### Comment Template
+The bot posts a formatted note:
+- Informs that the issue is implemented in version X
+- Provides update instructions
+- Offers subscription to updates mailing list (brightway.groups.io)
+- Includes bot identification
+
+---
+
+## Workflow Dependencies
+
+### Secrets Required
+- `GITHUB_TOKEN` - Automatically provided by GitHub Actions
+- `CONDA_LCA` - Anaconda upload token for beta releases
+- `CONDA_UPLOAD_TOKEN` - Anaconda upload token for stable releases
+
+### Configuration Files
+- `.github/conda-envs/build.yml` - Conda environment for building packages
+- `.github/changelog-configuration.json` - Changelog generation configuration
+- `.github/scripts/update_wiki.sh` - Wiki update script
+- `recipe/meta.yaml` - Conda package recipe
+- `pyproject.toml` - Python package configuration
+
+---
+
+## Development Notes
+
+### Running Tests Locally
+To run the same tests that CI runs:
+```bash
+pip install .[testing]
+pytest -s --no-header --no-summary -q
+```
+
+### Testing Matrix Changes
+When modifying the test matrix (OS or Python versions):
+- Update both `testing.yaml` and `install-canary.yaml` to keep them in sync
+- Consider the maintenance burden of additional combinations
+- Current support: Python 3.10-3.12, Ubuntu/Windows/macOS
+
+### Release Process
+1. **Beta release:** Push to `beta` branch → Auto-publishes beta version
+2. **Stable release:** Create and push a tag → Creates GitHub release and publishes to Anaconda
+3. **Close milestone:** When closing a milestone → Users get notified automatically
+
+### Monitoring
+- Check daily canary runs to catch dependency issues
+- Review failed test runs in PR checks before merging
+- Monitor PyPI and Anaconda Cloud for successful uploads
+

.github/workflows/build-executable.yml

@@ -0,0 +1,45 @@
+name: Build Executable
+on:
+  push:
+    branches: [ major ]
+    tags: '*'
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest, macos-15]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install system dependencies (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libegl1 libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 libxcb-shape0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v2
+
+      - name: Sync dependencies
+        shell: bash
+        run: |
+          uv add pyinstaller
+          uv sync --prerelease=allow        
+
+      - name: Build executable with PyInstaller
+        shell: bash
+        run: |
+          uv run pyinstaller pyinstaller.spec
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: activity-browser-${{ matrix.os }}
+          path: dist/*

.github/workflows/install-canary.yaml

@@ -3,113 +3,16 @@ on:
   schedule:
     # Run the tests once every 24 hours to catch dependency problems early
     - cron: '0 7 * * *'
-  push:
-    branches:
-      - install-canary
 
 jobs:
-  canary-installs:
-    timeout-minutes: 12
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-13]
-        python-version: ["3.10", "3.11"]
-    defaults:
-      run:
-        shell: bash -l {0}
-    steps:
-      - name: Setup python ${{ matrix.python-version }} conda environment
-        uses: conda-incubator/setup-miniconda@v3
-        with:
-          python-version: ${{ matrix.python-version }}
-          miniconda-version: "latest"
-      - name: Install activity-browser
-        run: |
-          conda create -y -n ab -c conda-forge --solver libmamba activity-browser python=${{ matrix.python-version }}
-      - name: Environment info
-        run: |
-          conda activate ab
-          conda list
-          conda env export
-          conda env export -f env.yaml
-      - name: Upload final environment as artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: env-${{ matrix.os }}-${{ matrix.python-version }}
-          path: env.yaml
-
-  # also run install with micromamba instead of conda to have a timing comparison
-  canary-installs-mamba:
-    runs-on: ${{ matrix.os }}
-    timeout-minutes: 30
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.11']
-    defaults:
-      run:
-        shell: bash -l {0}
-    steps:
-      - name: Setup python ${{ matrix.python-version }} conda environment
-        uses: mamba-org/setup-micromamba@v1
-        with:
-          micromamba-version: '1.5.9-1'
-          environment-name: ab
-          create-args: >-
-            python=${{ matrix.python-version }}
-            activity-browser
-      - name: Environment info
-        run: |
-          micromamba list
-          micromamba env export
-          micromamba env export > env.yaml
-      - name: Upload final environment as artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: env-${{ matrix.os }}-${{ matrix.python-version }}-mamba
-          path: env.yaml
-
-  conda-micromamba-comparison:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash -l {0}
-    needs:
-      - canary-installs
-      - canary-installs-mamba
-    steps:
-      - name: Download all artifacts
-        uses: actions/download-artifact@v4
-      - name: show files
-        run: |
-          ls -la
-      - name: correct yaml formatting
-        # add correct indentation to make diffing possible
-        uses: mikefarah/yq@master
-        with:
-          cmd: |
-            ls | grep mamba | while read d; do yq -i $d/env.yaml; done
-      - name: diff ubuntu
-        run: |
-          diff -u env-ubuntu-latest-3.11* || :
-      - name: diff windows
-        run: |
-          diff -u env-windows-latest-3.11* || :
-      - name: diff macos
-        run: |
-          diff -u env-macos-latest-3.11* || :
-
   canary-installs-pip:
     timeout-minutes: 12
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, windows-latest, macos-13  ]
-        python-version: [ '3.10' ]
+        os: [ubuntu-latest, windows-latest, macos-15, macos-latest]
+        py-version: ["3.10", "3.11", "3.12"]
     defaults:
       run:
         shell: bash -e {0}