Breaking changes badge for "main" branch (#1140)

breaking changes badge for main branch

.github/workflows/rc-breaking-changes.yaml

@@ -0,0 +1,28 @@
+name: Main branch breaking changes check
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  breaking-changes:
+    name: Check "main" for breaking changes before release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Set up Go 1.22.6
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.22.6'
+      - name: Install gorelease tool
+        run: |
+          go install golang.org/x/exp/cmd/gorelease@latest
+      - name: Run Breaking Changes Script
+        run: |
+          go run ./tools/breakingchanges/cmd/main.go --ignore tools

README.md

@@ -2,6 +2,7 @@
 
 # Chainlink Testing Framework
 
+[![Main branch breaking changes check](https://github.com/smartcontractkit/chainlink-testing-framework/actions/workflows/rc-breaking-changes.yaml/badge.svg)](https://github.com/smartcontractkit/chainlink-testing-framework/actions/workflows/rc-breaking-changes.yaml)
 [![Lib tag](https://img.shields.io/github/v/tag/smartcontractkit/chainlink-testing-framework?filter=%2Alib%2A)](https://github.com/smartcontractkit/chainlink-testing-framework/tags)
 [![WASP tag](https://img.shields.io/github/v/tag/smartcontractkit/chainlink-testing-framework?filter=%2Awasp%2A)](https://github.com/smartcontractkit/chainlink-testing-framework/tags)
 [![Seth tag](https://img.shields.io/github/v/tag/smartcontractkit/chainlink-testing-framework?filter=%2Aseth%2A)](https://github.com/smartcontractkit/chainlink-testing-framework/tags)

RELEASE.md

@@ -41,25 +41,21 @@ module github.com/smartcontractkit/chainlink-testing-framework/wasp/v2
 If your module have `cmd/main.go` we build binary automatically for various platforms and attach it to the release page.
 
 ## Debug Release Pipeline
-Since some components of pipeline are relying on published Go modules index and Dependabot we have a test script to verify the release pipeline:
+To test the release pipeline use `$pkg/$subpkg/v1.999.X-test-release` tags, they are retracted so consumers can't accidentally install them
 
-To test release for any module use `$pkg/$subpkg/v1.999.X-test-release` tags, they are retracted so consumers can't accidentally install them
+Create a test file inside `.changeset` with format `v1.999.X-test-release.md`, tag and push:
 ```
-nix develop
-python ./scripts/test-package-release.py -tag k8s-test-runner/v1.999.0-test-release -package ./k8s-test-runner
+git tag k8s-test-runner/v1.999.X-test-release && git push --tags
 ```
 
-To remove all the test tags use
-```
-nix develop
-python3 ./scripts/test-package-release.py -remove-test-tags
-```
 
 [Pipeline for releasing Go modules](.github/workflows/release-go-module.yml)
 [Dependabot summary pipeline](.github/workflows/dependabot-consumers-summary.yaml)
 
 ## Check breaking changes locally
 We have a simple wrapper to check breaking changes for all the packages. Commit all your changes and run:
 ```
-./scripts/breaking-changes.sh
+go run ./tools/breakingchanges/cmd/main.go
+go run ./tools/breakingchanges/cmd/main.go --subdir wasp # check recursively starting with subdir
+go run ./tools/breakingchanges/cmd/main.go --ignore tools,wasp,havoc,seth # to ignore some packages
 ```