Merge pull request #232 from dbcli/amjith/ci-updates

Update GH workflows

Author: amjith

.github/workflows/ci.yml

@@ -7,16 +7,19 @@ on:
       - 'AUTHORS'
 
 jobs:
-  build:
+  tests:
+    name: Tests
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: astral-sh/setup-uv@v1
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
         with:
           version: "latest"
 
@@ -31,5 +34,29 @@ jobs:
       - name: Run unit tests
         run: uv run tox -e py${{ matrix.python-version }}
 
-      - name: Run Style Checks
-        run: uv run tox -e style
+  tests-no-extras:
+    name: Tests Without Extras
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]   # Just the latest version
+
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev -p ${{ matrix.python-version }}
+
+      - name: Run unit tests
+        run: uv run tox -e py${{ matrix.python-version }}

.github/workflows/codeql.yml

@@ -0,0 +1,29 @@
+name: Lint
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'AUTHORS'
+
+jobs:
+  linters:
+    name: Linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+        # remember to sync the ruff-check version number with pyproject.toml
+      - name: Run ruff check
+        uses: astral-sh/ruff-action@57714a7c8a2e59f32539362ba31877a1957dded1 # v3.5.1
+        with:
+          version: 0.11.5
+
+        # remember to sync the ruff-check version number with pyproject.toml
+      - name: Run ruff format
+        uses: astral-sh/ruff-action@57714a7c8a2e59f32539362ba31877a1957dded1 # v3.5.1
+        with:
+          version: 0.11.5
+          args: 'format --check'

.github/workflows/lint.yml

@@ -39,6 +39,10 @@ jobs:
     runs-on: ubuntu-latest
     needs: [test]
 
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
     steps:
     - uses: actions/checkout@v4
     - uses: astral-sh/setup-uv@v1
@@ -48,10 +52,10 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.12'
+        python-version: {{ matrix.python-version }}
 
     - name: Install dependencies
-      run: uv sync --all-extras -p 3.12
+      run: uv sync --all-extras -p {{ matrix.python-version }}
 
     - name: Build
       run: uv build

.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `litecli/`: Core package. Entry point `main.py`, SQL execution in `sqlexecute.py`, completion in `packages/completion_engine.py`, special commands under `packages/special/`.
+- `tests/`: Pytest suite (files like `test_*.py`). Test data under `tests/data/`.
+- `screenshots/`: Images used in README.
+- Config template: `litecli/liteclirc` (user config is created under `~/.config/litecli/config` or `%LOCALAPPDATA%/dbcli/litecli/config`).
+
+## Build, Test, and Development Commands
+- Create env: `python -m venv .venv && source .venv/bin/activate`.
+- Install dev deps: `pip install -e .[dev]`.
+- Run all tests + coverage: `tox`.
+- Style/lint (ruff): `tox -e style` (runs `ruff check --fix` and `ruff format`).
+- Extra tests with SQLean: `tox -e sqlean` (installs `[sqlean]` extras).
+- Run tests directly: `pytest -v` or focused: `pytest -k keyword`.
+- Launch CLI locally: `litecli path/to.db`.
+
+## Coding Style & Naming Conventions
+- Formatter/linter: Ruff (configured via `.pre-commit-config.yaml` and `tox`).
+- Indentation: 4 spaces. Line length: 140 (see `pyproject.toml`).
+- Naming: modules/functions/variables `snake_case`; classes `CamelCase`; tests `test_*.py`.
+- Keep imports sorted and unused code removed (ruff enforces).
+
+## Testing Guidelines
+- Framework: Pytest with coverage (`coverage run -m pytest` via tox).
+- Location: place new tests in `tests/` alongside related module area.
+- Conventions: name files `test_<unit>.py`; use fixtures from `tests/conftest.py`.
+- Quick check: `pytest -q`; coverage report via `tox` or `coverage report -m`.
+
+## Commit & Pull Request Guidelines
+- Commits: imperative mood, concise scope (e.g., `fix: handle NULL types`). Reference issues (`#123`) when relevant.
+- Update `CHANGELOG.md` for user-visible changes.
+- PRs: include clear description, steps to reproduce/verify, and screenshots or snippets for CLI output when helpful. Use the PR template.
+- Ensure CI passes (tests + ruff). Re-run `tox -e style` before requesting review.
+
+## Security & Configuration Tips
+- Do not commit local databases or secrets. Use files under `tests/data/` for fixtures.
+- User settings live outside the repo; document defaults by editing `litecli/liteclirc`.