Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions breaking/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ inputs:
required: false
default: 'true'
github-token:
description: 'GitHub token used to post the review link as a pull-request comment, so reviewers see it on the PR instead of only in the job summary. Pass the built-in github.token and grant the job permissions: pull-requests: write. Optional; when omitted the link is written only to the job summary. On fork pull requests the token is read-only, so commenting is skipped and the link falls back to the job summary.'
description: 'GitHub token used to post the review link as a pull-request comment, so reviewers see it on the PR instead of only in the job summary. Defaults to the built-in github.token, so the comment is posted automatically when the job grants permissions: pull-requests: write. Set to an empty string to disable the comment (the link then appears only in the job summary). On fork pull requests the token is read-only, so commenting is skipped and the link falls back to the job summary.'
required: false
default: ''
default: ${{ github.token }}
outputs:
breaking:
description: 'Output summary of API breaking changes, encompassing both warnings and errors'
Expand Down
6 changes: 4 additions & 2 deletions breaking/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,11 @@ post_review_comment () {
body="${marker}
### 📋 [View the side-by-side API change review](${review_url})

See exactly what changed, in context. Share this link with your team: anyone can open the review, no install and no account needed. It expires in 7 days.
The link expires in 7 days.

🔒 Your specs stay private. They're encrypted before upload, and only this link can unlock them. [How it works →](https://www.oasdiff.com/docs/free-review#privacy)"
🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. [How it works →](https://www.oasdiff.com/docs/free-review#privacy)

<sub>Posted automatically by the [oasdiff GitHub Action](https://www.oasdiff.com/docs/free-review#github-action). To turn this off (no spec upload, no comment), set \`review: false\` on the action.</sub>"
elif [ -n "$existing_id" ]; then
body="${marker}
### ✅ No breaking changes in the latest revision."
Expand Down
4 changes: 2 additions & 2 deletions changelog/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ inputs:
required: false
default: 'true'
github-token:
description: 'GitHub token used to post the review link as a pull-request comment, so reviewers see it on the PR instead of only in the job summary. Pass the built-in github.token and grant the job permissions: pull-requests: write. Optional; when omitted the link is written only to the job summary. On fork pull requests the token is read-only, so commenting is skipped and the link falls back to the job summary.'
description: 'GitHub token used to post the review link as a pull-request comment, so reviewers see it on the PR instead of only in the job summary. Defaults to the built-in github.token, so the comment is posted automatically when the job grants permissions: pull-requests: write. Set to an empty string to disable the comment (the link then appears only in the job summary). On fork pull requests the token is read-only, so commenting is skipped and the link falls back to the job summary.'
required: false
default: ''
default: ${{ github.token }}
outputs:
changelog:
description: 'Output summary of API changelog'
Expand Down
6 changes: 4 additions & 2 deletions changelog/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,11 @@ post_review_comment () {
body="${marker}
### 📋 [View the side-by-side API change review](${review_url})

See exactly what changed, in context. Share this link with your team: anyone can open the review, no install and no account needed. It expires in 7 days.
The link expires in 7 days.

🔒 Your specs stay private. They're encrypted before upload, and only this link can unlock them. [How it works →](https://www.oasdiff.com/docs/free-review#privacy)"
🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. [How it works →](https://www.oasdiff.com/docs/free-review#privacy)

<sub>Posted automatically by the [oasdiff GitHub Action](https://www.oasdiff.com/docs/free-review#github-action). To turn this off (no spec upload, no comment), set \`review: false\` on the action.</sub>"
elif [ -n "$existing_id" ]; then
body="${marker}
### ✅ No API changes in the latest revision."
Expand Down
Loading