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

Api Diff Report CI #11236

Merged
merged 27 commits into from
May 10, 2023
Merged

Api Diff Report CI #11236

merged 27 commits into from
May 10, 2023

Conversation

sunmou99
Copy link
Contributor

@sunmou99 sunmou99 commented May 5, 2023

This is the workflow that detects API changes and generate API Diff Report and add public-api-change label.
New commit will trigger a new workflow run and cancel previous workflow.

There are 3 types of report:

  1. ⏳ Detecting API diff in progress... (Meaning workflow in progress. I do see github API that could hide the comment😔)
  2. ✅ No API Diff detected
  3. Apple API Diff Report + diff detail. Plus label public-api-change

The report is informative and the workflow won't block the merge.
The workflow is GREEN if an report been created (No API diff or API diff).
The workflow is RED only then the workflow itself has an issue.

@firebase firebase deleted a comment from github-actions bot May 5, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 5, 2023

✅  No API diff detected

Commit: 565614a
Last updated: Wed May 10 11:37 PDT 2023
View workflow logs & download artifacts


@sunmou99 sunmou99 marked this pull request as ready for review May 5, 2023 23:25
Copy link
Contributor

@yifanyang yifanyang left a comment

Choose a reason for hiding this comment

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

Left a few comments. Let me know if you want to discuss about them offline.

.github/workflows/api_report.yml Outdated Show resolved Hide resolved
.github/workflows/api_report.yml Outdated Show resolved Hide resolved
.github/workflows/api_report.yml Outdated Show resolved Hide resolved
.github/workflows/api_report.yml Outdated Show resolved Hide resolved
.github/workflows/api_report.yml Outdated Show resolved Hide resolved
scripts/api_diff_report/api_diff_report.py Outdated Show resolved Hide resolved
scripts/api_diff_report/api_diff_report.py Show resolved Hide resolved
scripts/api_diff_report/pr_commenter.py Show resolved Hide resolved
scripts/api_diff_report/pr_commenter.py Show resolved Hide resolved
scripts/api_diff_report/pr_commenter.py Outdated Show resolved Hide resolved
.github/workflows/api_diff_report.yml Show resolved Hide resolved
.github/workflows/api_diff_report.yml Outdated Show resolved Hide resolved
scripts/api_diff_report/pr_commenter.py Show resolved Hide resolved
scripts/api_diff_report/pr_commenter.py Outdated Show resolved Hide resolved
scripts/api_diff_report/prerequisite.sh Show resolved Hide resolved
@sunmou99 sunmou99 requested review from ncooke3 and yifanyang May 10, 2023 19:51
@sunmou99 sunmou99 merged commit ecd4035 into master May 10, 2023
@sunmou99 sunmou99 deleted the api-diff-ci branch May 10, 2023 22:04
@firebase firebase locked and limited conversation to collaborators Jun 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants