PRs tagged as breaking with ! should have minor changes in changeset

[nedsalk]

#2863 has a breaking changes section due to #2777 but it's not a minor bump. This should have been caught in the CI. We have logic to verify that, if the changeset file has minor changes that the PR should have the ! suffix, but we don't have the inverse check that if a PR is tagged as breaking that the changesets should contain minor changes.

[mvares]

@nedsalk, I assume that this solution could resolve it:

# Check if the PR title contains an exclamation mark (breaking)
if echo "$PR_TITLE" | grep -q '!'; then
  # If the PR is breaking, ensure that the changeset contains minor changes
  if ! echo "$AFFECTED_PACKAGES" | grep -q 'minor'; then
    echo "PR is marked as breaking but changeset does not contain minor changes."
    echo "Changeset file: $CHANGESET_FILE"
    echo "Changeset content:"
    cat "$CHANGESET_FILE"
    exit 1
  fi
else
  # If the PR is not breaking, ensure that minor changes are not present in the changeset
  if echo "$AFFECTED_PACKAGES" | grep -q 'minor'; then
    echo "Changeset has `minor` changes. Please mark the PR as breaking by adding an exclamation mark to its title (e.g. fix!: xxx) or use a `patch` instead."
    exit 1
  fi
fi

Flow:

sequenceDiagram
    participant PR as Pull Request
    participant CI as Continuous Integration
    participant Changeset as Changeset File

    %% PR with title containing '!'
    PR->>CI: PR Title with !
    CI->>Changeset: Check for minor changes
    Changeset->>CI: Contains minor changes?
    CI->>PR: If yes, proceed
    CI->>PR: If no, error (Changeset should indicate at least a minor bump)

    %% PR with title without '!'
    PR->>CI: PR Title without !
    CI->>Changeset: Check for minor changes
    Changeset->>CI: Contains minor changes?
    CI->>PR: If yes, error (PR title should reflect breaking changes)
    CI->>PR: If no, proceed

    %% Minor Changes Check
    Changeset->>CI: Indicates minor bump?
    CI->>PR: If no, error (PR title should have '!')
    CI->>PR: If yes, proceed

Loading

[nedsalk]

Yes, please create a PR for this if you want.