Skip to content

Stamp the action version on service calls and the /review URL #142

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.

Sign up for GitHub

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

Merged
reuvenharrison merged 1 commit into from
Jun 5, 2026
Merged

Stamp the action version on service calls and the /review URL #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion breaking/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ if [ -n "$breaking_changes" ] && ! echo "$breaking_changes" | head -n 1 | grep -
# commit where the file lives at a different path.
base_sha=$(jq -r '.pull_request.base.sha // empty' "$GITHUB_EVENT_PATH" 2>/dev/null || echo "")
if [ -z "$base_sha" ]; then base_sha=$(git rev-parse "origin/$GITHUB_BASE_REF" 2>/dev/null || echo "$GITHUB_BASE_REF"); fi
free_review_url="https://www.oasdiff.com/review?owner=${owner}&repo=${repo}&base_sha=$(urlencode "$base_sha")&rev_sha=${head_sha}&base_file=$(urlencode "$base_path")&rev_file=$(urlencode "$rev_path")"
free_review_url="https://www.oasdiff.com/review?owner=${owner}&repo=${repo}&base_sha=$(urlencode "$base_sha")&rev_sha=${head_sha}&base_file=$(urlencode "$base_path")&rev_file=$(urlencode "$rev_path")&action_version=$(urlencode "${GITHUB_ACTION_REF:-unknown}")"
echo "::notice::📋 Review & approve these breaking changes → ${free_review_url}"
# The Step Summary surfaces both the link (for visitors who'd rather use
# the web UI) and the CLI command itself (for visitors who recognize it
Expand Down
2 changes: 1 addition & 1 deletion changelog/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ if [ -n "$output" ] && ! echo "$output" | head -n 1 | grep -q "^No "; then
# commit where the file lives at a different path.
base_sha=$(jq -r '.pull_request.base.sha // empty' "$GITHUB_EVENT_PATH" 2>/dev/null || echo "")
if [ -z "$base_sha" ]; then base_sha=$(git rev-parse "origin/$GITHUB_BASE_REF" 2>/dev/null || echo "$GITHUB_BASE_REF"); fi
free_review_url="https://www.oasdiff.com/review?owner=${owner}&repo=${repo}&base_sha=$(urlencode "$base_sha")&rev_sha=${head_sha}&base_file=$(urlencode "$base_path")&rev_file=$(urlencode "$rev_path")"
free_review_url="https://www.oasdiff.com/review?owner=${owner}&repo=${repo}&base_sha=$(urlencode "$base_sha")&rev_sha=${head_sha}&base_file=$(urlencode "$base_path")&rev_file=$(urlencode "$rev_path")&action_version=$(urlencode "${GITHUB_ACTION_REF:-unknown}")"
echo "::notice::📋 Review & approve these API changes → ${free_review_url}"
# The Step Summary surfaces both the link (for visitors who'd rather use
# the web UI) and the CLI command itself (for visitors who recognize it
Expand Down
3 changes: 2 additions & 1 deletion pr-comment/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ if [ -n "$base_sha" ]; then
else
free_base_sha=$(git rev-parse "origin/$GITHUB_BASE_REF" 2>/dev/null || echo "$GITHUB_BASE_REF")
fi
free_review_url="https://www.oasdiff.com/review?owner=${owner}&repo=${repo}&base_sha=$(urlencode "$free_base_sha")&rev_sha=${head_sha}&base_file=$(urlencode "$base_path")&rev_file=$(urlencode "$rev_path")"
free_review_url="https://www.oasdiff.com/review?owner=${owner}&repo=${repo}&base_sha=$(urlencode "$free_base_sha")&rev_sha=${head_sha}&base_file=$(urlencode "$base_path")&rev_file=$(urlencode "$rev_path")&action_version=$(urlencode "${GITHUB_ACTION_REF:-unknown}")"
echo "::notice::📋 View API changes → ${free_review_url}"

# Build the JSON payload. The `changes` array can be very large for
Expand Down Expand Up @@ -166,6 +166,7 @@ fi
response=$(printf '%s' "$payload" | curl -s -w "\n%{http_code}" -X POST \
"${service_url}/tenants/${oasdiff_token}/pr-comment" \
-H "Content-Type: application/json" \
-H "User-Agent: oasdiff-action/${GITHUB_ACTION_REF:-unknown}" \
--data-binary @-)

http_code=$(echo "$response" | tail -1)
Expand Down
1 change: 1 addition & 0 deletions verify/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ payload=$(jq -nc \
response=$(printf '%s' "$payload" | curl -s -w "\n%{http_code}" -X POST \
"${service_url}/tenants/${oasdiff_token}/verify" \
-H "Content-Type: application/json" \
-H "User-Agent: oasdiff-action/${GITHUB_ACTION_REF:-unknown}" \
--data-binary @-)
http_code=$(echo "$response" | tail -1)
body=$(echo "$response" | sed '$d')
Expand Down
Loading