Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
cast

GitHub Action

Report Breaking Changes

v1.0.0

Report Breaking Changes

cast

Report Breaking Changes

Automatically update an issue and/or discussion with breaking changes

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Report Breaking Changes

uses: tmillr/breaking-change@v1.0.0

Learn more about this action in tmillr/breaking-change

Choose a version

Breaking Change

This GitHub action automatically detects breaking changes by scanning the messages of pushed commits for conventional commit syntax. For each commit that signals a breaking change, its message content will be posted as a comment on a preselected/predetermined GitHub issue and/or discussion (whose number is specified via the action's inputs). The action will error if neither an issue or discussion is specified, although both may be specified. The order of commits are preserved and are reflected in the order of the comments. Such a discussion or issue not only serves as a central, autonomous, chronological log of breaking changes, but also as a source of breaking change notifications for users who subscribe to the issue/discussion.

Usage

  - name: Report Breaking Changes
    uses: tmillr/breaking-change@v1
    # Only trigger on push events occurring on your release branch
    if: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
    with:
      # The token that will be used for posting the comments
      token: ${{ github.token }}
      # Issue and/or discussion # where breaking changes will be reported
      issueNumber: 1

See action.yml for all possible inputs and outputs.

Tips

  • Lock the issue/discussion used for reporting breaking changes (only allow maintainers etc. to comment).

Caveats

  • Using the issue/discussion method alone, it may not be clear or obvious which reported breaking changes belong to which versions/releases of the software.

  • The code of this action is quite simple, but this action has yet to undergo thorough testing.

  • Only works with conventional commits.