Skip to content

fix(ci): changelog-gate should accept .changeset/ files as alternative to CHANGELOG.md edits #745

Closed

Description

@diberry

Problem

The \changelog-gate\ CI check in \squad-ci.yml\ requires CHANGELOG.md to be modified when SDK/CLI source files change. This causes merge conflicts when multiple PRs are open simultaneously — every PR edits the same [Unreleased]\ section.

The repo already has Changesets configured (.changeset/config.json). The intended workflow is:

  • PRs add a .changeset/*.md\ file (unique per PR, no conflicts)
  • CHANGELOG.md is generated at release time via \changeset version`n

Solution

Update \changelog-gate\ job in .github/workflows/squad-ci.yml\ to accept EITHER:

  • A .changeset/*.md\ file added/modified, OR
  • CHANGELOG.md modified (backward compatible)

Also

  • Update CONTRIBUTING.md to document the changeset workflow
  • Remove direct CHANGELOG.md edits from existing PRs, replace with .changeset/\ files
  • Add \skip-changelog\ label as documented escape hatch

Activity

  1. added a commit that references this issue on Apr 2, 2026
    9fa1c93
  2. diberry commented on Apr 2, 2026

    @diberry
    ContributorAuthor

    Additional requirement: CHANGELOG.md write protection gate — only approved authors (bradygaster, github-actions[bot]) can modify CHANGELOG.md directly. All others must use changeset files.

  3. added 2 commits that reference this issue on Apr 2, 2026
    c8ef640
    d8c1382
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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions