Skip to content

Add E2E-based breaking change detection via CI#128

Open
Aaravanand00 wants to merge 1 commit intohyperledger-identus:mainfrom
Aaravanand00:chore/add-breaking-change-detection
Open

Add E2E-based breaking change detection via CI#128
Aaravanand00 wants to merge 1 commit intohyperledger-identus:mainfrom
Aaravanand00:chore/add-breaking-change-detection

Conversation

@Aaravanand00
Copy link
Copy Markdown

Summary
This PR introduces a simple breaking change detection mechanism by running the existing E2E integration tests in CI.

What’s changed

  1. Added a GitHub Actions workflow to run integration tests on pull requests and pushes to main
  2. Uses the existing npm run integration command as the source of truth for E2E validation
  3. The workflow fails if integration tests fail, helping catch potential breaking changes early
  4. Added a short note in the README about E2E-based breaking change detection

Why this approach
Instead of introducing additional tooling, this relies on the current integration test setup as a practical signal for breaking changes, which keeps the solution simple and aligned with how the project is already tested.

Notes

  1. The workflow currently uses the sdk-ts runner, aligned with the existing CI setup for Linux environments
  2. Other SDK runners (swift, kmp) may require platform-specific setups or are not part of the current CI flow, so they are not included here

Copilot AI review requested due to automatic review settings April 22, 2026 10:10
@Aaravanand00 Aaravanand00 force-pushed the chore/add-breaking-change-detection branch from b1ac1ef to ccffd3e Compare April 22, 2026 10:11
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an additional CI signal intended to catch breaking changes earlier by running the repository’s existing E2E integration test entrypoint (npm run integration) on PRs and pushes to main.

Changes:

  • Added a new GitHub Actions workflow to run E2E integration tests in CI.
  • Updated README with a brief note about CI-based E2E breaking change detection.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
README.md Documents that E2E tests run in CI for breaking-change detection.
.github/workflows/e2e-breaking-check.yml Introduces a PR/push workflow intended to execute npm run integration -- --runner sdk-ts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/e2e-breaking-check.yml
Comment thread .github/workflows/e2e-breaking-check.yml
Comment thread .github/workflows/e2e-breaking-check.yml
Comment thread .github/workflows/e2e-breaking-check.yml
@Aaravanand00 Aaravanand00 force-pushed the chore/add-breaking-change-detection branch 2 times, most recently from 43994da to 8e64e7f Compare April 22, 2026 10:49
Copilot AI review requested due to automatic review settings April 22, 2026 10:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/e2e-breaking-check.yml
Comment thread .github/workflows/e2e-breaking-check.yml
Comment thread .github/workflows/e2e-breaking-check.yml
Comment thread .github/workflows/e2e-breaking-check.yml Outdated
Signed-off-by: Aaravanand00 <aaravanand5749@gmail.com>
@Aaravanand00 Aaravanand00 force-pushed the chore/add-breaking-change-detection branch from 8e64e7f to efd286c Compare April 22, 2026 10:55
@sonarqubecloud
Copy link
Copy Markdown

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants