chore: implement CI/CD, linting, type checking, and remove due date syncing

jack-champagne · jack-champagne · commit 20798a8ad4eb · 2026-02-08T01:49:47.000-05:00
- Configure Ruff for linting and formatting
- Add Mypy for static type checking and fix existing type errors
- Set up GitHub Actions CI workflow with Python 3.13
- Implement pre-commit hooks for local quality checks
- Remove due date parsing and syncing as per TASKS.md
- Update documentation (README, FORMAT, CONTRIBUTING) to reflect changes
- Fix failing tests and clean up unused code
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Run ruff check
+        run: ruff check .
+
+      - name: Run ruff format check
+        run: ruff format --check .
+
+      - name: Run type check
+        run: mypy tasksmd_sync/
+
+      - name: Run tests
+        run: pytest
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+      - id: mypy
+        additional_dependencies: [httpx, pyyaml]
+        files: ^tasksmd_sync/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,55 @@
+# Contributing to tasksmd-sync
+
+Thank you for your interest in contributing! This project uses a few tools to ensure code quality and consistency.
+
+## Development Setup
+
+1. Clone the repository
+2. Create a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # or .venv\Scripts\activate on Windows
+   ```
+3. Install the package in editable mode with development dependencies:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+4. Install pre-commit hooks:
+   ```bash
+   pre-commit install
+   ```
+
+## Code Quality Tools
+
+We use the following tools to maintain code quality:
+
+- **Ruff:** For linting and formatting.
+- **Mypy:** For static type checking.
+- **Pytest:** For unit testing.
+
+You can run these locally:
+
+```bash
+# Run linter
+ruff check .
+
+# Run formatter
+ruff format .
+
+# Run type checker
+mypy tasksmd_sync/
+
+# Run tests
+pytest
+```
+
+## Workflow
+
+1. Create a new branch for your feature or bugfix.
+2. Ensure all tests pass and there are no linting or type errors.
+3. Submit a Pull Request.
+4. CI will run all checks automatically on your PR.
+
+## Versioning
+
+This project follows [Semantic Versioning](https://semver.org/). Version tags should be created on the `main` branch.
diff --git a/FORMAT.md b/FORMAT.md
@@ -17,7 +17,6 @@ A TASKS.md file is organized into **status sections**, each containing **task bl
 <!-- id: PVTI_lADOBx... -->
 - **Assignee:** @username
 - **Labels:** bug, urgent
-- **Due:** 2025-03-15
 
 Description of the task goes here. Can be multiple paragraphs,
 include code blocks, lists, etc.
@@ -35,7 +34,6 @@ reverse-sync pass.
 <!-- id: PVTI_lADOBx456 -->
 - **Assignee:** @doc
 - **Labels:** feature, core
-- **Due:** 2025-06-01
 
 Multi-paragraph description with code:
 
@@ -74,7 +72,6 @@ Each task block starts with a `### heading` (h3) and continues until the next `#
 - `<!-- id: PVTI_... -->` — hidden project board item ID for matching. Injected by the sync tool on creation. If absent, a new board item is created.
 - `- **Assignee:** @username` — GitHub username (with or without `@`)
 - `- **Labels:** label1, label2` — comma-separated list of labels
-- `- **Due:** YYYY-MM-DD` — due date in ISO format
 
 **Description:**
 Everything after the metadata lines until the next task or section heading. Supports full GitHub-flavored markdown.
@@ -85,7 +82,6 @@ Everything after the metadata lines until the next task or section heading. Supp
 |-------|--------|---------|
 | Assignee | `@username` or `username` | `@octocat` |
 | Labels | Comma-separated strings | `bug, urgent, P0` |
-| Due | ISO 8601 date | `2025-03-15` |
 | Status | Determined by parent `##` section | (implicit) |
 
 ### ID Comments
diff --git a/README.md b/README.md
@@ -34,7 +34,6 @@ Tasks are organized by status sections using markdown headings:
 <!-- id: PVTI_abc123 -->
 - **Assignee:** @alice
 - **Labels:** feature, security
-- **Due:** 2025-06-01
 
 Description of the task goes here. Supports full GitHub-flavored
 markdown including code blocks, lists, and links.
@@ -64,7 +63,6 @@ Configured GitHub Actions for tests and linting.
 | Board ID | `<!-- id: PVTI_... -->` | No (auto-assigned) |
 | Assignee | `- **Assignee:** @username` | No |
 | Labels | `- **Labels:** label1, label2` | No |
-| Due Date | `- **Due:** YYYY-MM-DD` | No |
 | Status | Determined by parent `##` section | Yes (implicit) |
 | Description | Free text after metadata | No |
 
@@ -106,7 +104,10 @@ tasksmd-sync TASKS.md \
 | `--org` | GitHub org login (required) |
 | `--project-number` | Project board number (required) |
 | `--token` | GitHub token (or set `GITHUB_TOKEN` / `TASKSMD_GITHUB_TOKEN` env var) |
+| `--repo` | Target repository for creating real Issues (format: `owner/repo`) |
 | `--repo-label` | Label to scope archive detection to this repo's items |
+| `--archive-done` | Archive tasks in the `Done` section and remove them from `TASKS.md` |
+| `--writeback` | Write board item IDs back into `TASKS.md` (default: false) |
 | `--dry-run` | Preview changes without executing |
 | `--verbose` / `-v` | Enable debug logging |
 | `--output-json` | Write sync results to a JSON file |
diff --git a/TASKS.md b/TASKS.md
@@ -1,6 +1,6 @@
 # Tasks
 
-## Todo
+## Done
 
 ### Add PR comment summary for dry-run in CI
 <!-- id: PVTI_lADOC9ysqc4BETyazglCHLI -->
@@ -30,5 +30,3 @@ corresponding GitHub Issues. This includes:
 - Adding missing labels to issues.
 - Removing labels that are no longer present in TASKS.md.
 
-## Done
-
diff --git a/action.yml b/action.yml
@@ -48,7 +48,7 @@ runs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.11'
+        python-version: '3.13'
 
     - name: Install tasksmd-sync
       shell: bash
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,8 +14,39 @@ dependencies = [
     "pyyaml>=6.0",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.3",
+    "mypy>=1.0",
+    "pre-commit>=3.0",
+]
+
 [project.scripts]
 tasksmd-sync = "tasksmd_sync.cli:main"
 
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "C",   # flake8-comprehensions
+    "B",   # flake8-bugbear
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501", # Line too long
+    "C901", # Function too complex
+    "E741", # Ambiguous variable name
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["tasksmd_sync"]
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
diff --git a/tasksmd_sync/cli.py b/tasksmd_sync/cli.py
@@ -11,7 +11,7 @@
 from .github_projects import GitHubProjectClient
 from .parser import parse_tasks_file
 from .sync import execute_sync
-from .writeback import writeback_ids, remove_done_tasks
+from .writeback import remove_done_tasks, writeback_ids
 
 
 def main(argv: list[str] | None = None) -> int:
diff --git a/tasksmd_sync/models.py b/tasksmd_sync/models.py
@@ -16,7 +16,6 @@ class Task:
     board_item_id: str | None = None
     assignee: str | None = None
     labels: list[str] = field(default_factory=list)
-    due_date: date | None = None
 
     @property
     def has_board_id(self) -> bool:
@@ -33,8 +32,6 @@ def metadata_dict(self) -> dict:
             d["assignee"] = self.assignee
         if self.labels:
             d["labels"] = sorted(self.labels)
-        if self.due_date:
-            d["due_date"] = self.due_date.isoformat()
         return d
 
 
@@ -54,7 +51,7 @@ def by_status(self) -> dict[str, list[Task]]:
 
     @property
     def by_board_id(self) -> dict[str, Task]:
-        return {t.board_item_id: t for t in self.tasks if t.has_board_id}
+        return {t.board_item_id: t for t in self.tasks if t.board_item_id is not None}
 
     @property
     def unlinked_tasks(self) -> list[Task]:
diff --git a/tasksmd_sync/parser.py b/tasksmd_sync/parser.py
@@ -14,10 +14,6 @@
 RE_BOARD_ID = re.compile(r"^<!--\s*id:\s*(\S+)\s*-->$")
 RE_ASSIGNEE = re.compile(r"^-\s+\*\*Assignee:\*\*\s*@?(\S+)\s*$")
 RE_LABELS = re.compile(r"^-\s+\*\*Labels:\*\*\s*(.+)$")
-RE_DUE = re.compile(r"^-\s+\*\*Due:\*\*\s*(\d{4}-\d{2}-\d{2})\s*$")
-
-# Set of metadata patterns for detecting the boundary between metadata and description
-METADATA_PATTERNS = [RE_BOARD_ID, RE_ASSIGNEE, RE_LABELS, RE_DUE]
 
 
 def parse_tasks_md(content: str, source_path: str = "") -> TaskFile:
@@ -91,7 +87,6 @@ def __init__(self, title: str, status: str) -> None:
         self.board_item_id: str | None = None
         self.assignee: str | None = None
         self.labels: list[str] = []
-        self.due_date: date | None = None
         self._desc_lines: list[str] = []
         self._in_metadata = True
 
@@ -114,11 +109,6 @@ def feed_line(self, line: str) -> None:
                 self.labels = [l.strip() for l in raw.split(",") if l.strip()]
                 return
 
-            m = RE_DUE.match(line)
-            if m:
-                self.due_date = date.fromisoformat(m.group(1))
-                return
-
             # Blank lines in metadata zone are skipped
             if line.strip() == "":
                 return
@@ -138,5 +128,4 @@ def build(self) -> Task:
             board_item_id=self.board_item_id,
             assignee=self.assignee,
             labels=self.labels,
-            due_date=self.due_date,
         )
diff --git a/tasksmd_sync/sync.py b/tasksmd_sync/sync.py
@@ -120,15 +120,15 @@ def build_sync_plan(
     for bi in board_items:
         if bi.item_id in seen_board_ids:
             continue
-        
+
         # Scoping: only archive items that belong to the specified repo/label
         # If repo_owner/repo_name are provided, use them (preferred)
         if repo_owner and repo_name:
             if bi.repo_owner != repo_owner or bi.repo_name != repo_name:
                 continue
         elif repo_label and repo_label not in bi.labels:
             continue
-            
+
         plan.archive.append(bi)
 
     return plan
@@ -366,12 +366,6 @@ def _needs_update(task: Task, board_item: ProjectItem) -> bool:
             logger.debug("    task:  %r", task_desc)
             logger.debug("    board: %r", board_desc)
         return True
-    if task.due_date and task.due_date != board_item.due_date:
-        logger.debug(
-            "  [DIFF] '%s' due_date: %s != %s",
-            task.title, task.due_date, board_item.due_date,
-        )
-        return True
     # Assignees and Labels are properties of the underlying content node, not
     # project fields.  We can only sync them when the content is a real Issue;
     # DraftIssues don't support assignees/labels via the API, so comparing
@@ -423,15 +417,8 @@ def _apply_task_fields(
                 list(status_field.options.keys()),
             )
 
-    # Due date — map to "End date" field (or "Due" as fallback)
-    if task.due_date:
-        due_field = fields.get("End date") or fields.get("Due")
-        if due_field:
-            client.update_item_field_date(item_id, due_field.id, task.due_date)
-
     # Assignees and Labels — only syncable on real Issues (not DraftIssues)
-    is_issue = board_item and board_item.content_type == "Issue" and board_item.content_id
-    if is_issue:
+    if board_item and board_item.content_type == "Issue" and board_item.content_id:
         if task.assignee and task.assignee != board_item.assignee:
             user_id = client.resolve_user_id(task.assignee)
             if user_id:
diff --git a/tasksmd_sync/writeback.py b/tasksmd_sync/writeback.py
@@ -26,13 +26,13 @@ def remove_done_tasks(tasks_path: str | Path) -> bool:
     lines = path.read_text(encoding="utf-8").splitlines(keepends=True)
     new_lines: list[str] = []
     modified = False
-    
+
     current_status = None
     i = 0
     while i < len(lines):
         line = lines[i]
         stripped = line.rstrip("\n").rstrip("\r")
-        
+
         # Check for status heading
         m = RE_STATUS_HEADING.match(stripped)
         if m:
@@ -41,7 +41,7 @@ def remove_done_tasks(tasks_path: str | Path) -> bool:
             new_lines.append(line)
             i += 1
             continue
-            
+
         # Check for task heading
         m = RE_TASK_HEADING.match(stripped)
         if m:
@@ -60,7 +60,7 @@ def remove_done_tasks(tasks_path: str | Path) -> bool:
                 new_lines.append(line)
                 i += 1
                 continue
-        
+
         new_lines.append(line)
         i += 1
 
@@ -74,9 +74,9 @@ def remove_done_tasks(tasks_path: str | Path) -> bool:
                 continue
             final_lines.append(line)
             last_blank = is_blank
-            
+
         path.write_text("".join(final_lines), encoding="utf-8")
-        
+
     return modified
 
 
diff --git a/tests/test_archive_done.py b/tests/test_archive_done.py
diff --git a/tests/test_execute_sync.py b/tests/test_execute_sync.py
diff --git a/tests/test_parser.py b/tests/test_parser.py
diff --git a/tests/test_sync.py b/tests/test_sync.py
diff --git a/tests/test_writeback.py b/tests/test_writeback.py
