Skip to content

Coderabbit config#104

Merged
ejfine merged 7 commits intomainfrom
coderabbit-config
Oct 30, 2025
Merged

Coderabbit config#104
ejfine merged 7 commits intomainfrom
coderabbit-config

Conversation

@ejfine
Copy link
Contributor

@ejfine ejfine commented Oct 30, 2025

Why is this change necessary?

Better instructions for coderabbit

How does this change address the issue?

Adds a config file

What side effects does this change have?

N/A

How is this change tested?

Live during the Pull Request

Other

Bumped some other versions

Summary by CodeRabbit

  • Chores
    • Updated development and CI tooling versions (Nuxt, FastAPI, pnpm, GH Actions, installer tooling and related dependencies).
    • Added a project-level code-review configuration to set review profile, path-based rules, and disable selected linters in pre-commit.
    • Introduced a structured-logging version entry and template links to propagate configuration across templates.
    • Minor devcontainer metadata update.

@ejfine ejfine self-assigned this Oct 30, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 30, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Adds CodeRabbit configuration files and template references, updates devcontainer metadata and UV version, and bumps multiple tool and dependency versions (including uv, pnpm, FastAPI, Nuxt, zod, GH Actions). Also adds structlog_version to the template context.

Changes

Cohort / File(s) Change Summary
CodeRabbit configuration
\.coderabbit.yaml, template/\.coderabbit.yaml, template/template/\.coderabbit.yaml
Added CodeRabbit config with review profile "assertive", path_instructions marking generated/vendor files, and disabled pre-commit linters (eslint, ruff, pylint, flake8). Template files reference parent config.
Devcontainer tooling
\.devcontainer/devcontainer.json, \.devcontainer/install-ci-tooling.py
Updated devcontainer context hash comment; bumped UV_VERSION from 0.9.5 to 0.9.6.
Template/context version pins
extensions/context.py, template/extensions/context.py.jinja-base
Bumped many tool/dependency versions (uv, pnpm, FastAPI, Nuxt, nuxt_ui, dotenv_cli, nuxt_eslint, zod, zod_from_json_schema, types_node, several GH Actions actions) and added structlog_version = "25.5.0" to the template context.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Areas to review closely:
    • Confirm .coderabbit.yaml path_instructions correctly match generated/vendor directories and intended files.
    • Verify disabling linters in CodeRabbit config is intentional and scoped appropriately.
    • Check compatibility of bumped versions (FastAPI, Nuxt, zod, GH Actions).
    • Ensure structlog_version is properly propagated via the jinja template and referenced where expected.

Possibly related PRs

  • Coderabbit config #104 — Appears to modify the same files (adds .coderabbit.yaml and updates versions) and likely duplicates these changes.
  • More kiota support #103 — Updates UV_VERSION in .devcontainer/install-ci-tooling.py and overlaps on devcontainer/tooling version bumps.
  • OpenAPI codegen support #102 — Adjusts template context entries and version pins in extensions/context.py, related to the structlog_version addition.

Poem

🐰 I hopped through files to leave a trail,
Configs snugly placed and versions hale.
A tiny bump, a template link,
Structlog joins our version sync—
Off I go to nibble more code kale. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "Coderabbit config" directly relates to the primary change in this pull request—the addition of .coderabbit.yaml configuration files in multiple locations (.coderabbit.yaml, template/.coderabbit.yaml, and template/template/.coderabbit.yaml). While the changeset also includes secondary version bumps across dependencies (which the author notes as "Other"), the stated purpose and main objective is to add CodeRabbit configuration for better instructions. The title clearly summarizes this primary change and would allow a teammate scanning history to understand the main intent of the PR.
Description Check ✅ Passed The pull request description follows the provided template structure and addresses five of the six sections: "Why is this change necessary?", "How does this change address the issue?", "What side effects does this change have?", "How is this change tested?", and "Other". The only missing section is "Link to Issue or Message thread", which can be considered non-critical if there is no associated issue or message thread to reference. The description is mostly complete with all core informational sections filled, even though some entries are brief.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f272634 and a4574cd.

📒 Files selected for processing (7)
  • .coderabbit.yaml (1 hunks)
  • .devcontainer/devcontainer.json (1 hunks)
  • .devcontainer/install-ci-tooling.py (1 hunks)
  • extensions/context.py (3 hunks)
  • template/.coderabbit.yaml (1 hunks)
  • template/extensions/context.py.jinja-base (1 hunks)
  • template/template/.coderabbit.yaml (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ejfine ejfine requested a review from Copilot October 30, 2025 13:45
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates various package and tool versions across the project template. The changes include Python package versions, Node.js package versions, GitHub Actions versions, and adds support for a new dependency (structlog).

  • Updates multiple dependency versions including uv (0.9.5→0.9.6), pnpm (10.19.0→10.20.0), FastAPI (0.120.1→0.120.2), and several GitHub Actions
  • Adds structlog version configuration (25.5.0) to context variables
  • Creates CodeRabbit configuration files with symbolic links to root config

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
extensions/context.py Updates version numbers for multiple dependencies and adds structlog_version context variable
template/extensions/context.py.jinja-base Adds structlog_version template variable to context
.devcontainer/install-ci-tooling.py Updates UV_VERSION from 0.9.5 to 0.9.6
.devcontainer/devcontainer.json Updates devcontainer context hash
.coderabbit.yaml Creates new CodeRabbit configuration file with review settings
template/.coderabbit.yaml Creates symbolic link to parent CodeRabbit config
template/template/.coderabbit.yaml Creates symbolic link to grandparent CodeRabbit config

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ejfine
Copy link
Contributor Author

ejfine commented Oct 30, 2025

@CodeRabbit full review

@coderabbitai
Copy link

coderabbitai bot commented Oct 30, 2025

✅ Actions performed

Full review triggered.

@ejfine
Copy link
Contributor Author

ejfine commented Oct 30, 2025

@coderabbitai full review

@coderabbitai
Copy link

coderabbitai bot commented Oct 30, 2025

✅ Actions performed

Full review triggered.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f272634 and 58d5021.

📒 Files selected for processing (7)
  • .coderabbit.yaml (1 hunks)
  • .devcontainer/devcontainer.json (1 hunks)
  • .devcontainer/install-ci-tooling.py (1 hunks)
  • extensions/context.py (3 hunks)
  • template/.coderabbit.yaml (1 hunks)
  • template/extensions/context.py.jinja-base (1 hunks)
  • template/template/.coderabbit.yaml (1 hunks)
🔇 Additional comments (10)
.devcontainer/install-ci-tooling.py (1)

8-8: LGTM! Version bump is clean.

The UV version update from 0.9.5 to 0.9.6 is correctly applied and will be used consistently in the installation URLs.

template/extensions/context.py.jinja-base (1)

43-43: LGTM! Structlog version context entry added correctly.

The new structlog_version placeholder follows the established pattern and is properly positioned among other Python package versions.

.devcontainer/devcontainer.json (1)

64-64: LGTM! Metadata update reflects context changes.

The devcontainer context hash update is managed automatically by the pre-commit hook and reflects the tooling version updates in this PR.

extensions/context.py (3)

14-14: LGTM! UV version bump is consistent.

The UV version update to 0.9.6 matches the change in .devcontainer/install-ci-tooling.py, ensuring consistency across the codebase.


48-48: LGTM! New structlog version added.

The new structlog_version entry (25.5.0) is properly positioned and corresponds to the template placeholder in template/extensions/context.py.jinja-base.


60-60: Remove this review comment as it conflates template configuration with breaking changes.

This file is a Copier template context hook that sets default versions for projects generated from this template. It is not an active CI configuration. The repository contains no .github/workflows files, meaning these version strings don't directly control any active workflows. Projects generated from this template will use these defaults, but that's a template maintenance concern, not a breaking change requiring verification for this repository's own operation. The review comment incorrectly treats template configuration changes as if they were active workflow updates.

Likely an incorrect or invalid review comment.

template/.coderabbit.yaml (1)

1-1: LGTM! Template configuration reference is correct.

The reference to ../.coderabbit.yaml correctly links this template directory to the root CodeRabbit configuration, establishing a consistent configuration inheritance pattern.

template/template/.coderabbit.yaml (1)

1-1: LGTM! Nested template configuration reference is correct.

The reference to ../../.coderabbit.yaml correctly links this nested template directory to the root CodeRabbit configuration, maintaining consistent configuration inheritance.

.coderabbit.yaml (2)

1-2: LGTM! Assertive profile enabled for comprehensive feedback.

Setting the review profile to "assertive" will provide more detailed and thorough code review feedback, which aligns with the PR's objective of better instructions for CodeRabbit.


3-11: LGTM! Path instructions properly exclude generated and vendor code.

The path instructions correctly identify:

  • Generated OpenAPI client code (two naming variants)
  • Generated GraphQL TypeScript client
  • Vendor files

These exclusions prevent unnecessary review comments on code that shouldn't be modified.

Comment on lines +12 to +21
tools:
# these are already run by pre-commit, and coderabbit often generates false positives
eslint:
enabled: false
ruff:
enabled: false
pylint:
enabled: false
flake8:
enabled: false
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify that pre-commit runs the disabled linters.

The configuration disables eslint, ruff, pylint, and flake8 in CodeRabbit to avoid duplication with pre-commit. Ensure these tools are actually configured and active in the pre-commit configuration.


🏁 Script executed:

#!/bin/bash
# Check if .pre-commit-config.yaml exists and includes the disabled linters
if [ -f .pre-commit-config.yaml ]; then
  echo "=== Checking for eslint in pre-commit config ==="
  rg -n "eslint" .pre-commit-config.yaml
  
  echo ""
  echo "=== Checking for ruff in pre-commit config ==="
  rg -n "ruff" .pre-commit-config.yaml
  
  echo ""
  echo "=== Checking for pylint in pre-commit config ==="
  rg -n "pylint" .pre-commit-config.yaml
  
  echo ""
  echo "=== Checking for flake8 in pre-commit config ==="
  rg -n "flake8" .pre-commit-config.yaml
else
  echo "No .pre-commit-config.yaml found"
fi

Length of output: 785


ESLint and flake8 are not configured in pre-commit—remove them from CodeRabbit's disabled tools or add them to pre-commit.

Verification reveals that ruff and pylint are correctly configured in pre-commit (lines 245–260 and 275–288 respectively), so disabling them in CodeRabbit makes sense. However, eslint and flake8 are missing from the pre-commit configuration entirely, yet remain disabled in .coderabbit.yaml. Either re-enable eslint and flake8 in CodeRabbit or add them to the pre-commit configuration to avoid a linting gap.

🤖 Prompt for AI Agents
.coderabbit.yaml around lines 12 to 21: the file currently disables eslint and
flake8 while those linters are not present in pre-commit, creating a linting
gap; either remove eslint and flake8 from the disabled list in .coderabbit.yaml
or (preferable) add eslint and flake8 to the repository's pre-commit
configuration by adding appropriate pre-commit hooks and ensuring their config
files (.eslintrc/.flake8) exist, then run pre-commit install and test the hooks
to confirm both tools run locally and in CI.

@ejfine ejfine merged commit 1687846 into main Oct 30, 2025
7 checks passed
@ejfine ejfine deleted the coderabbit-config branch October 30, 2025 14:09
@coderabbitai
Copy link

coderabbitai bot commented Oct 30, 2025

✅ Actions performed

Full review triggered.

This was referenced Oct 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants