Merge pull request #72 from UBC-MDS/otter

Create release 2.0.0

Author: yhouyang02

.github/dependabot.yml

@@ -0,0 +1,60 @@
+name: Build and Test Package
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for 
+  # the main branch and the otter (staging) branch
+  push:
+    branches: [ main, otter ]
+  pull_request:
+    branches: [ main, otter ]
+
+  # Allows to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  lint_check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[lint]
+
+      - name: Run ruff formatter
+        run: |
+          ruff check .
+
+  build_and_test_package:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.13"]
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[tests]
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov --cov-report=term --cov-branch

.github/workflows/build.yml

@@ -0,0 +1,71 @@
+name: Publish to TestPyPI
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch: # Manual trigger
+
+jobs:
+  build-and-test:
+    name: Build and Test Package
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out your repository so your job can access it
+      - name: Check-out repository
+        uses: actions/checkout@v2
+
+      # Set up Python
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev,tests]
+
+      # Run pytest with coverage
+      - name: Run tests with coverage
+        run: |
+          pytest --cov --cov-report=term --cov-branch
+
+      - name: Build package using Hatch
+        run: |
+          hatch build
+          echo ""
+          echo "Generated files:"
+          ls -lh dist/
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to TestPyPI
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/wordguess/
+    permissions:
+      id-token: write  # MANDATORY for trusted publishing
+
+    steps:
+      - name: Download dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

.github/workflows/deploy.yml

@@ -1,27 +1,43 @@
-name: Build Docs
+name: Render and Publish docs
 
 on:
-  pull_request:
   push:
-    branches:
+    branches: 
       - main
+  workflow_dispatch:
 
 jobs:
-  build-docs:
+  render-docs:
     runs-on: ubuntu-latest
-
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v4.5.2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v5.1.0
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      # Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v4
         with:
-            python-version: ${{ matrix.python-version }}
+          python-version: '3.10'
 
-      - name: Install hatch
+      # Install dependencies
+      - name: Install dependencies
         run: |
-            python -m pip install --upgrade pip
-            python -m pip install hatch
+          python -m pip install --upgrade pip
+          pip install -e .[docs]
 
-      - name: Build documentation using Hatch
+      # manually call quartodoc build
+      - name: quartodoc build
         run: |
-            hatch run docs:build
+          quartodoc build
+
+      - name: Render and Publish
+        uses: quarto-dev/quarto-actions/publish@v2
+        with:
+          target: gh-pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yml

@@ -243,3 +243,9 @@ cython_debug/
 
 # Hatch-VCS
 _version.py
+
+/.quarto/
+**/*.quarto_ipynb
+_site
+reference
+objects.json

.github/workflows/release.yml

@@ -32,3 +32,29 @@ All notable changes to this project will be documented in this file.
 - Added tests for `get_score`
 - Added tests for `result_to_pattern`
 - Added package-level imports in `__init__.py`
+
+## [2.0.0] - 2026-01-24
+
+- Fixed typos and format issues
+- Fixed code linting errors
+- Updated `README.md` with installation and development guides
+- Updated `CONTRIBUTING.md` with code formatter and linter change
+- Updated `CONTRIBUTING.md` with hyperlinks
+- Updated `CODE_OF_CONDUCT.md` with enforcement guidelines and contact info
+- Added documentation site
+- Added Quarto configuration for documentation site
+- Added Quarto-related dependencies
+- Added `environment.yml` for development environment setup
+- Added `index.qmd` as documentation homepage
+- Added GitHub Actions workflow for package building and testing
+- Added GitHub Actions workflow for code quality checks
+- Added GitHub Actions workflow for publishing package to TestPyPI
+- Added GitHub Actions workflow for documentation rendering and publishing
+- Added one more test case in `tests/unit/test_result_to_pattern.py`
+- Added three test cases in `tests/unit/test_get_score.py`
+- Added one more test case in `tests/unit/test_get_result.py`
+- Added validation for penalty rate in `src/wordguess/get_score.py`
+- Added validation for empty result lists in `src/wordguess/get_score.py`
+- Removed unused `docs` directory and Sphinx configuration
+- Removed unused GitHub Actions workflows
+- Removed Sphinx-related dependencies from `pyproject.toml`