Skip to content

[pr-review-doc-context-enrichment] Version bump + CHANGELOG + docs #69

@orioltf

Description

@orioltf

Parent

docs/issues/pr-review-doc-context-enrichment/PRD.md

What to build

Finalise metadata, documentation, and release artefacts for the doc context enrichment feature.

Before running the bump script, check what version the re-review feature shipped at (docs/issues/pr-review-rereview/09-version-bump-and-release.md). The bump for this feature must target the next available minor version after re-review — do not hardcode a version number here.

Steps (in order):

  1. Add CHANGELOG entry. Under ## [Unreleased] in CHANGELOG.md, add under ### Added:

    Doc Context enrichment: before review agents run, fetch linked ADO work items and any Confluence pages referenced in their descriptions; inject structured, diff-aware summaries as business context into every review agent's prompt. Requires Confluence credentials (CONFLUENCE_URL, CONFLUENCE_USER, CONFLUENCE_TOKEN or ~/.unic-confluence.json) for Confluence page fetching; degrades gracefully when absent or unreachable.

  2. Bump the version. Run pnpm --filter pr-review bump minor. This updates both .claude-plugin/plugin.json and .claude-plugin/marketplace.json atomically. Never hand-edit marketplace.json.

  3. Update README.md. Add a section describing the Doc Context enrichment capability: what it does, credential prerequisites (CONFLUENCE_URL, CONFLUENCE_USER, CONFLUENCE_TOKEN or ~/.unic-confluence.json), and graceful degradation behaviour.

  4. Update CLAUDE.md. Remove "PR description generation from diff" and any doc-context-enrichment roadmap lines if present. Verify that new step 4a is reflected in the repository layout description.

  5. Verify. Run pnpm --filter pr-review verify:changelog locally before opening the PR.

Acceptance criteria

  • pnpm --filter pr-review verify:changelog passes locally
  • Versions match across plugin.json and marketplace.json
  • CHANGELOG.md has a dated entry for the new version under ### Added
  • README.md documents the enrichment capability and credential prerequisites
  • CI passes on the release PR

Blocked by

Comments

This was generated by AI during triage.

Why this is ready-for-human, not ready-for-agent:
The version number cannot be determined without first knowing what version the re-review feature shipped at. That requires checking a real-time state (docs/issues/pr-review-rereview/09-version-bump-and-release.md) that may not be resolved when this issue is picked up. Additionally, the CHANGELOG entry and README section involve prose decisions that benefit from human authorship. The mechanical bump step (pnpm --filter pr-review bump minor) is straightforward once the version is confirmed.


PRD: docs/issues/pr-review-doc-context-enrichment/PRD.md
Migrated from: docs/issues/pr-review-doc-context-enrichment/04-version-bump-and-docs.md (source removed after migration)
Touched by PRs: #19, #21, #25

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions