Skip to content

Doc-consistency tests fail after auto-release across tool repos #5

Description

@TMHSDigital

During Phase 1 rollout (Issue #1), Docker-Developer-Tools and Steam-Cursor-Plugin had failing doc-consistency tests:

  • test_changelog_has_current_version
  • test_roadmap_current_version
  • test_claude_md_version
  • test_roadmap.py::test_current_matches_plugin_version

All check that CHANGELOG.md, ROADMAP.md, and CLAUDE.md reference the current plugin.json version. The failures occur because release.yml bumps plugin.json but does not update those docs. Every auto-release creates stale docs that the test suite then flags.

Observed on: Docker-Developer-Tools, Steam-Cursor-Plugin.
Pattern likely exists in any tool repo with both auto-release AND doc-consistency tests.

Fix options:

  1. Extend release.yml in each tool repo to also update CHANGELOG/ROADMAP/CLAUDE
  2. Relax the doc-consistency tests to not require the current version
  3. Have release.yml generate a follow-up commit that updates docs

The auto-release pattern is ecosystem-wide (6 of 8 active repos auto-released during Phase 1), so this drift is recurring rather than a one-time bug.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions