Skip to content

Conversation

imjasonh
Copy link
Owner

Summary

This PR tests the apidiff-action's ability to comment on pull requests when breaking API changes are detected.

Changes

  • Add pull-requests: write permission to CI workflow
  • Add new test-pr-comment job that runs only on PRs
  • Enable comment-on-pr: true for the breaking changes test

Expected Result

When this PR is merged, the action should automatically add a comment showing:

# API Compatibility Check Results

## Summary

| Type | Count |
|------|-------|
| Breaking changes | 3 |
| Compatible changes | 1 |

⚠️ **This PR contains breaking API changes\!**

## Details

#### ❌ Breaking changes

- (*Greeter).Greet: changed from func() string to func(bool) string
- MaxRetries: removed
- Process: changed from func(string) (string, error) to func(context.Context, string) (string, error)

#### ✅ Compatible changes

- Greeter.Language: added

This demonstrates the action working on real PRs to help reviewers understand API changes.

🤖 Generated with Claude Code

- Add pull-requests: write permission to CI workflow
- Add test-pr-comment job that runs only on PRs
- Enable comment-on-pr for breaking changes test
- This will create a comment showing the API changes
Copy link
Contributor

API Compatibility Check Results

Summary

Type Count
Breaking changes 3
Compatible changes 1

⚠️ This PR contains breaking API changes!

Details

❌ Breaking changes

  • (*Greeter).Greet: changed from func() string to func(bool) string
  • MaxRetries: removed
  • Process: changed from func(string) (string, error) to func(context.Context, string) (string, error)

✅ Compatible changes

  • Greeter.Language: added

@imjasonh imjasonh closed this Jul 29, 2025
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.

1 participant