Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

scripts: ci: Detect API-breaking changes in the PRs #15326

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

doki-nordic
Copy link
Contributor

This script will check the PR's changes in the header files and DTS bindings that may affects compatibility of the public API. This will reduce risk of accidentally breaking the API. Workflow that runs on each PR will add a comment with analysis summary.

@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label May 15, 2024
@doki-nordic doki-nordic self-assigned this May 16, 2024
@doki-nordic doki-nordic force-pushed the pr-api-changes-detection branch 2 times, most recently from 2be339c to b414551 Compare May 16, 2024 09:09
This script will check the PR's changes in the header files and DTS
bindings that may affects compatibility of the public API. This will
reduce risk of accidentally breaking the API. Workflow that runs
on each PR will add a comment with analysis summary.

Signed-off-by: Dominik Kilian <Dominik.Kilian@nordicsemi.no>
@doki-nordic doki-nordic marked this pull request as ready for review May 16, 2024 09:26
@doki-nordic doki-nordic requested review from tejlmand and a team as code owners May 16, 2024 09:26
@wbober
Copy link
Contributor

wbober commented May 17, 2024

I didn't go deep into the implementation but I would suggest to:

  1. add a readme with some details how to use the script, what args it takes, etc.
  2. brief description on how it works
  3. I'd move the table that details current detection rules into the repository.

@shanthanordic shanthanordic requested review from jorgenmk, shanthanordic, PerMac, ns-tolu and ablam and removed request for a team May 31, 2024 07:29
Copy link

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

@github-actions github-actions bot added the Stale label Oct 14, 2024
@NordicBuilder
Copy link
Contributor

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 5

Inputs:

Sources:

more details

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ❌ Toolchain
  • ❌ Build twister
  • ❌ Integration tests

Note: This message is automatically posted and updated by the CI

@github-actions github-actions bot removed the Stale label Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. DNM
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants