chore(dev): static api analysis #6159

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.

Sign up for GitHub

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

Jump to bottom

Open

ekjotmultani wants to merge 68 commits into main from chore/api-analysis

Member

ekjotmultani commented Jun 3, 2025 •

edited

Loading

Issue #, if available:

Description of changes:

Introduced the aft generate api-report command to AFT. This command uses dart_apitool from @bmw-tech to create snapshots of our package's dart level API surfaces, and a change report for these. Developers must now always use this AFT command to generate these files for each package (just running the command as is once here works) on every Pull Request that is expected to merge into main.

This PR also includes a workflow for checking that these change reports are actually updated according to the changes on the PR branch, and a workflow for requiring additional approvals when an API change actually occurs (as shown by the lovely bot in this thread).

Overall this change to our development flow will enforce that developers are always aware of API changes to help us get the right eyes on it and to help with versioning.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.

github-actions bot added the api-changes label

Nika Hassani and others added 4 commits

June 3, 2025 11:23


          chore(ci): add api analysis for each category and core


          initial generat_api_report_command

d7b069e


          introduced generate api report command and github actions for checkin…

4ab729e

…g api change reports and requiring additional approval if needed


          changed third party job in action to github native

f5f5157

ekjotmultani force-pushed the chore/api-analysis branch from 93ffb4a to f5f5157 Compare

June 3, 2025 18:23

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          updated setup flutter step of workflow to match other workflows on th…

7af0df4

…is repo

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          removed cd into packages/aft as the generate api-report command works…

de740a6

… assuming we are at the root of the repo

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          properly running command from the root of the repo

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          included the newly updated api reports!

5c4bf2e

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.

ekjotmultani added 3 commits

June 3, 2025 13:43


          updated command to ingore dependencies to example apps

856e0ec


          Revert "updated command to ingore dependencies to example apps"

81a8c58

This reverts commit 856e0ec.


          simplified pubspecs of packages in the generate api report command

19560af

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          further changes to dependency check logic

e743395

github-actions bot commented Jun 3, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          include aft bootstrap in workflow to properly handle dependencies wit…

…h dart_apitool

github-actions bot commented Jun 4, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          updated command to run the super constructor

8c2c649

github-actions bot commented Jun 4, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          printing git diff

5a88d8d

github-actions bot commented Jun 5, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.


          updated check workflow to not just run git diff on the change report …

…and look specifically for the text that tells us if anything changed

github-actions bot commented Jun 5, 2025

⚠️ This PR contains API changes and requires careful review. Please ensure these changes are intentional and backward compatible where possible.

ekjotmultani added 18 commits

June 23, 2025 12:06


          Merge branch 'main' into chore/api-analysis

d87f9f6


          added option to filter packages on the generate command, updated flut…

571a333

…ter sdk on workflow but need to see how to get the latest version automatically


          Merge branch 'chore/api-analysis' of https://github.com/aws-amplify/a…

e0d6c45

…mplify-flutter into chore/api-analysis


          changed .yml extension to .yaml for consistency

a8ae912


          sorting json to check if local is consistent with actions

09ce37b


          reverted to output whole diff for investigation

04d86d4


          updated api reports with sorted keys

d00b4b3


          added sorting one level down in the generated json files to ensure co…

f1b98ad

…nsistency from local to gh actions


          removed unnecessary sorting of packages

5fd2b77


          reverted last change

1900e6e


          sorted executable declerations block

e9dfce5


          removed sorting from generate command, introduced sorting to the work…

586c497

…flow instead of comparing diffs


          updated comparison logic in workflow

f1068cf


          further updates to comparison logic

9edaff9


          deleted old api reports and added full diff logging

52a47f2


          Merge branch 'main' of https://github.com/aws-amplify/amplify-flutter …

9caf87a

…into chore/api-analysis


          merged main and updated api report for aws_common

c2eadf8


          updated action to not fail if diff detects changes

8e62dbf

tyllark requested changes

View reviewed changes

packages/aft/lib/src/commands/generate/generate_api_report_command.dart Outdated Show resolved Hide resolved

packages/aft/lib/src/commands/generate/generate_api_report_command.dart Outdated Show resolved Hide resolved

packages/aft/lib/src/commands/generate/generate_api_report_command.dart Outdated Show resolved Hide resolved

packages/aft/lib/src/commands/generate/generate_api_report_command.dart Outdated Show resolved Hide resolved

ekjotmultani added 6 commits

July 1, 2025 12:41


          used global options for selecting packages, used pubspec parse packag…

0792aae

…e for parsing pubspecs


          Merge branch 'main' into chore/api-analysis

767a5e8


          updated core package to reflect latest changes to main

331bdab


          regenerated core api json file to reflect latest changes

4005d92


          updated command to sort API surfaces by their interfaces, so that we …

23f9645

…have consistent ordering when viewing change reports


          Merge branch 'main' into chore/api-analysis

532097f

tyllark requested changes

View reviewed changes

Member

tyllark left a comment

Can you update the AFT ReadMe to reference this new command.

.github/workflows/api-report-check.yaml Outdated Show resolved Hide resolved

ekjotmultani added 4 commits

July 7, 2025 13:13


          updated command to use symlinks to a recreation of a package without …

995cefd

…its example subdirectory


          Merge branch 'chore/api-analysis' of https://github.com/aws-amplify/a…

adf51a9

…mplify-flutter into chore/api-analysis


          removed sorting from check action and updated aft readme to include u…

13e61b6

…se of API change reporting


          updated sorting

5228b43

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

Labels