Skip to content

Thin the free step summary to a link; add workflow param; drop the notice #144

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 2 commits into from
Jun 6, 2026
+16 −26
Merged

Thin the free step summary to a link; add workflow param; drop the notice #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c3a5e3
Thin the free step summary to a link; add workflow param; drop the no…
reuvenharrison Jun 6, 2026
949e7d1
Neutralize step-summary comments (drop internal strategy rationale fr…
reuvenharrison Jun 6, 2026
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
22 changes: 8 additions & 14 deletions breaking/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,22 +152,16 @@ 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
# GITHUB_WORKFLOW_REF is "<owner>/<repo>/.github/workflows/<file>@<ref>";
# strip the repo prefix and the @ref suffix to get the workflow file path.
wf_path="${GITHUB_WORKFLOW_REF#"$GITHUB_REPOSITORY"/}"
wf_path="${wf_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
# and want to skip the instruction-page detour). GitHub renders the
# fenced code block with a built-in copy button, so the one-step path
# for the familiar-visitor cohort is: scroll to the Checks tab, click
# copy on the command, paste into a terminal in the local clone, run.
[ -n "$wf_path" ] && free_review_url="${free_review_url}&workflow=$(urlencode "$wf_path")"
# Step summary: a link to the /review page, which shows how to view these
# changes side by side.
{
echo "### 📋 [Review & approve these breaking changes](${free_review_url})"
echo ""
echo "Or run locally in your clone of \`${repo}\`:"
echo ""
echo '```bash'
echo "git fetch origin ${base_sha} ${head_sha} && oasdiff breaking ${base_sha}:${base_path} ${head_sha}:${rev_path} --open"
echo '```'
echo "### 📋 [View these breaking changes in a side-by-side review](${free_review_url})"
} >> "$GITHUB_STEP_SUMMARY"
else
write_output "No breaking changes"
Expand Down
20 changes: 8 additions & 12 deletions changelog/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,20 +147,16 @@ 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
# GITHUB_WORKFLOW_REF is "<owner>/<repo>/.github/workflows/<file>@<ref>";
# strip the repo prefix and the @ref suffix to get the workflow file path.
wf_path="${GITHUB_WORKFLOW_REF#"$GITHUB_REPOSITORY"/}"
wf_path="${wf_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
# and want to skip the instruction-page detour). GitHub renders the
# fenced code block with a built-in copy button.
[ -n "$wf_path" ] && free_review_url="${free_review_url}&workflow=$(urlencode "$wf_path")"
# Step summary: a link to the /review page, which shows how to view these
# changes side by side.
{
echo "### 📋 [Review & approve these API changes](${free_review_url})"
echo ""
echo "Or run locally in your clone of \`${repo}\`:"
echo ""
echo '```bash'
echo "git fetch origin ${base_sha} ${head_sha} && oasdiff changelog ${base_sha}:${base_path} ${head_sha}:${rev_path} --open"
echo '```'
echo "### 📋 [View these API changes in a side-by-side review](${free_review_url})"
} >> "$GITHUB_STEP_SUMMARY"
else
write_output "No changelog changes"
Expand Down
Loading