Skip to content

Commit fcd4d11

Browse files
authored
Update README.md
1 parent cccc613 commit fcd4d11

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ swift build --configuration release
165165
```
166166

167167
## Github Action
168-
The public-api-diff can be used easily via the provided github action.
168+
The public-api-diff can be used easily via the provided github action, which creates a comment on a PR (if applicable) and also adds it to the Github step summary.
169169
```bash
170170
- name: 🔍 Detect Changes
171171
uses: Adyen/adyen-swift-public-api-diff@0.4.0
@@ -174,6 +174,7 @@ The public-api-diff can be used easily via the provided github action.
174174
new: "develop~https://github.com/Adyen/adyen-ios.git"
175175
old: "5.12.0~https://github.com/Adyen/adyen-ios.git"
176176
```
177+
See: [example workflow](https://github.com/Adyen/adyen-swift-public-api-diff/blob/main/Examples/github-workflow.yml)
177178

178179
## Alternatives
179180
- **swift-api-digester**

0 commit comments

Comments
 (0)