Skip to content

chore: minor updates to AGENTS.md and .pre-commit-config.yaml#1301

Merged
dbasunag merged 2 commits intoopendatahub-io:mainfrom
dbasunag:minor_changes
Mar 26, 2026
Merged

chore: minor updates to AGENTS.md and .pre-commit-config.yaml#1301
dbasunag merged 2 commits intoopendatahub-io:mainfrom
dbasunag:minor_changes

Conversation

@dbasunag
Copy link
Copy Markdown
Collaborator

@dbasunag dbasunag commented Mar 25, 2026

Pull Request

Summary

Related Issues

  • Fixes:
  • JIRA:

Please review and indicate how it has been tested

  • Locally
  • Jenkins

Additional Requirements

  • If this PR introduces a new test image, did you create a PR to mirror it in disconnected environment?
  • If this PR introduces new marker(s)/adds a new component, was relevant ticket created to update relevant Jenkins job?

Summary by CodeRabbit

  • Chores
    • Enhanced continuous integration automation for improved pull request workflows.
    • Updated contributor guidelines for managing system-level dependencies.

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>

Co-Authored-By: Claude <noreply@anthropic.com>
@dbasunag dbasunag requested a review from a team as a code owner March 25, 2026 21:23
@github-actions
Copy link
Copy Markdown

The following are automatically added/executed:

  • PR size label.
  • Run pre-commit
  • Run tox
  • Add PR author as the PR assignee
  • Build image based on the PR

Available user actions:

  • To mark a PR as WIP, add /wip in a comment. To remove it from the PR comment /wip cancel to the PR.
  • To block merging of a PR, add /hold in a comment. To un-block merging of PR comment /hold cancel.
  • To mark a PR as approved, add /lgtm in a comment. To remove, add /lgtm cancel.
    lgtm label removed on each new commit push.
  • To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
    verified label removed on each new commit push.
  • To Cherry-pick a merged PR /cherry-pick <target_branch_name> to the PR. If <target_branch_name> is valid,
    and the current PR is merged, a cherry-picked PR would be created and linked to the current PR.
  • To build and push image to quay, add /build-push-pr-image in a comment. This would create an image with tag
    pr-<pr_number> to quay repository. This image tag, however would be deleted on PR merge or close action.
Supported labels

{'/wip', '/verified', '/hold', '/cherry-pick', '/lgtm', '/build-push-pr-image'}

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 25, 2026

📝 Walkthrough

Walkthrough

Two configuration and documentation files modified. .pre-commit-config.yaml adds a CI auto-fix pull request configuration block. AGENTS.md adds contributor guidance requiring coordination when introducing new binaries or system-level dependencies, with Dockerfile and make build verification steps.

Changes

Cohort / File(s) Summary
CI Configuration
.pre-commit-config.yaml
Added top-level ci block with autofix_prs: true to enable pre-commit CI auto-fix behavior for pull requests.
Contributor Guidelines
AGENTS.md
Added "⚠️ Ask First" requirement to coordinate new binary or system dependency additions, mandating simultaneous Dockerfile updates and make build verification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 1 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning PR description is entirely a blank template with no substantive content—summary, issues, testing approach, and requirements sections are all unfilled placeholders. Complete the Summary section with actual change justification, confirm testing method (Locally/Jenkins), and fill related issue references if applicable.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed Title accurately reflects the main changes: updates to AGENTS.md and .pre-commit-config.yaml configuration files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown
Contributor

@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

🧹 Nitpick comments (1)
AGENTS.md (1)

91-91: Make the dependency-change rule explicit and enforceable.

Line 91 is ambiguous when multiple Dockerfiles or build targets exist. Specify exact file path(s) and make target(s) so contributors and reviewers apply one deterministic rule.

As per coding guidelines, "REVIEW PRIORITIES: 2. Architectural issues and anti-patterns".

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` at line 91, The rule "Adding new binaries or system-level
dependencies (must also update `Dockerfile` and verify with `make build`)" in
AGENTS.md is ambiguous; update that entry to explicitly list the exact
Dockerfile paths and make targets contributors must update and verify (e.g., the
repo root Dockerfile, ./deploy/Dockerfile, and the CI build target names such as
`make build`, `make image`, or any service-specific target), and require
updating the corresponding Dockerfile(s) and running the specified make
target(s) before submitting a PR; also add an enforceable checklist entry for
the PR template or CI job to validate that those files/targets were changed and
the build passed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.pre-commit-config.yaml:
- Around line 1-2: The CI config currently sets the "autofix_prs" flag which
causes bot commits that bypass local commit-msg hooks (e.g., DCO or
conventional-commit checks); either set "autofix_prs" to false to stop
pre-commit.ci from making auto-fix commits or keep it false and instead enforce
commit-msg policy server-side (push rules) so bot commits are validated; if you
must keep automated messages, consider using "autofix_commit_msg" only to
standardize text but note it will not trigger local commit-msg hooks — update
the "ci" block to disable "autofix_prs" and/or add server-side push-rule
enforcement for the commit-msg hook.

---

Nitpick comments:
In `@AGENTS.md`:
- Line 91: The rule "Adding new binaries or system-level dependencies (must also
update `Dockerfile` and verify with `make build`)" in AGENTS.md is ambiguous;
update that entry to explicitly list the exact Dockerfile paths and make targets
contributors must update and verify (e.g., the repo root Dockerfile,
./deploy/Dockerfile, and the CI build target names such as `make build`, `make
image`, or any service-specific target), and require updating the corresponding
Dockerfile(s) and running the specified make target(s) before submitting a PR;
also add an enforceable checklist entry for the PR template or CI job to
validate that those files/targets were changed and the build passed.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 30b05a2b-fc14-45c5-86a6-c5de715019b7

📥 Commits

Reviewing files that changed from the base of the PR and between 8a67a44 and fcdba4a.

📒 Files selected for processing (2)
  • .pre-commit-config.yaml
  • AGENTS.md

@dbasunag dbasunag merged commit 605ae99 into opendatahub-io:main Mar 26, 2026
10 checks passed
@dbasunag dbasunag deleted the minor_changes branch March 26, 2026 13:00
@github-actions
Copy link
Copy Markdown

Status of building tag latest: success.
Status of pushing tag latest to image registry: success.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants