Skip to content

Commit e17c458

Browse files
Merge pull request #184 from oasdiff/docs/changelog-diff-scope-wording
docs: state what changelog, breaking, and diff each cover
2 parents ae5ef64 + 2b7766a commit e17c458

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The following actions run the oasdiff CLI directly in your GitHub runner — no
7070

7171
### Check for breaking changes
7272

73-
Detects breaking changes and writes inline `::error::` annotations on the pull request's Files changed tab. Fails the workflow when changes at or above the `fail-on` severity are found. When changes are found it also uploads the comparison and links to a full side-by-side review (the `review` input, on by default); the two specs are encrypted in CI before upload, so the server cannot read them. The link is posted as a pull-request comment when you pass `github-token` (and grant `pull-requests: write`); otherwise, and on fork PRs where the token is read-only, it falls back to the job summary.
73+
Detects changes that break existing API clients and writes inline `::error::` annotations on the pull request's Files changed tab. Fails the workflow when changes at or above the `fail-on` severity are found. When changes are found it also uploads the comparison and links to a full side-by-side review (the `review` input, on by default); the two specs are encrypted in CI before upload, so the server cannot read them. The link is posted as a pull-request comment when you pass `github-token` (and grant `pull-requests: write`); otherwise, and on fork PRs where the token is read-only, it falls back to the job summary.
7474

7575
```yaml
7676
name: oasdiff
@@ -116,7 +116,7 @@ jobs:
116116

117117
### Generate a changelog
118118

119-
Outputs all changes (breaking and non-breaking) between two specs. When changes are found it also uploads the comparison and links to a full side-by-side review (the `review` input, on by default); the two specs are encrypted in CI before upload, so the server cannot read them. The link is posted as a pull-request comment when you pass `github-token` (and grant `pull-requests: write`); otherwise, and on fork PRs where the token is read-only, it falls back to the job summary.
119+
Outputs the changes that can affect API consumers (breaking and non-breaking) between two specs. Documentation-only edits, such as descriptions and examples, are not included; use the diff action to see every difference in the API definition. When changes are found it also uploads the comparison and links to a full side-by-side review (the `review` input, on by default); the two specs are encrypted in CI before upload, so the server cannot read them. The link is posted as a pull-request comment when you pass `github-token` (and grant `pull-requests: write`); otherwise, and on fork PRs where the token is read-only, it falls back to the job summary.
120120

121121
```yaml
122122
name: oasdiff
@@ -161,7 +161,7 @@ jobs:
161161

162162
### Generate a diff report
163163

164-
Outputs the raw structural diff between two specs.
164+
Outputs the full diff of the API definition between two specs, including documentation-only edits.
165165

166166
```yaml
167167
name: oasdiff

0 commit comments

Comments
 (0)