Skip to content

Add Agent Playbook section to README - #352

Open
stefanvacareanu7 wants to merge 1 commit into
masterfrom
docs/agent-update-playbook
Open

Add Agent Playbook section to README#352
stefanvacareanu7 wants to merge 1 commit into
masterfrom
docs/agent-update-playbook

Conversation

@stefanvacareanu7

Copy link
Copy Markdown
Contributor

Summary

  • Adds an "Agent Playbook: Updating This Repository End-to-End" section to README.md documenting how an automated agent should perform version bumps for this Codacy Prospector engine (requirements.txt pins, docs/patterns.json / docs/description hand-maintenance, Dockerfile base image, CircleCI job flow, and local/CI test verification steps).
  • Documentation only — no functional changes.

Test plan

  • N/A (README-only change). CI should still pass unchanged since no functional files were modified.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

The PR successfully introduces the 'Agent Playbook' section to the README, aligning with the requirement to document the end-to-end update process. Codacy analysis indicates the changes are up to standards. However, the documentation contains a technical error in the Docker unit testing command which would likely fail during execution because it does not account for the container's entrypoint or internal pathing. This issue should be resolved to ensure the playbook provides accurate instructions for local verification.

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

Comment thread README.md
1. **Bump the version(s)** in `requirements.txt` (Prospector and/or the specific sub-linter(s) named in the task).
2. **Update `docs/patterns.json` and `docs/description/*` by hand** only if the release adds, removes, or renames a bundled sub-tool — otherwise leave them untouched.
3. **Rebuild the Docker image**: `docker build -t codacy-prospector:latest .`
4. **Run the engine's own unit tests inside the image** (this is what CI's `publish_docker_local` job does): `docker run codacy-prospector:latest codacy_prospector_test.py`

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 MEDIUM RISK

The command to run unit tests is likely missing the python interpreter and the correct absolute path. If the image uses an ENTRYPOINT for the linter, this command will attempt to lint the test file instead of executing it. Try running the following prompt in your coding agent: > Check the Dockerfile to determine the ENTRYPOINT and WORKDIR. Update the unit test execution commands in README.md (at line 56 and line 76) to use the correct syntax, ensuring they invoke the python interpreter with the correct absolute path to codacy_prospector_test.py inside the container.

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.

1 participant