Skip to content

Step Summary: include CLI command as a copyable code block (CLI Local Review Phase 1, step 5 of 5) #125

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
May 28, 2026
Merged

Step Summary: include CLI command as a copyable code block (CLI Local Review Phase 1, step 5 of 5) #125

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
17 changes: 16 additions & 1 deletion breaking/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,22 @@ if [ -n "$breaking_changes" ] && ! echo "$breaking_changes" | head -n 1 | grep -
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")"
echo "::notice::📋 Review & approve these breaking changes → ${free_review_url}"
echo "### 📋 [Review & approve these breaking changes](${free_review_url})" >> "$GITHUB_STEP_SUMMARY"
# 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.
# See enterprise/docs/cli-local-review.md (Phase 1, step 5).
{
echo "### 📋 [Review & approve these breaking changes](${free_review_url})"
echo ""
echo "Or run locally in your clone of \`${repo}\`:"
echo ""
echo '```bash'
echo "oasdiff breaking ${base_sha}:${base_path} ${head_sha}:${rev_path} --open"
echo '```'
} >> "$GITHUB_STEP_SUMMARY"
else
write_output "No breaking changes"
fi
Expand Down
15 changes: 14 additions & 1 deletion changelog/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,20 @@ if [ -n "$output" ] && ! echo "$output" | head -n 1 | grep -q "^No "; then
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")"
echo "::notice::📋 Review & approve these API changes → ${free_review_url}"
echo "### 📋 [Review & approve these API changes](${free_review_url})" >> "$GITHUB_STEP_SUMMARY"
# 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. See
# enterprise/docs/cli-local-review.md (Phase 1, step 5).
{
echo "### 📋 [Review & approve these API changes](${free_review_url})"
echo ""
echo "Or run locally in your clone of \`${repo}\`:"
echo ""
echo '```bash'
echo "oasdiff changelog ${base_sha}:${base_path} ${head_sha}:${rev_path} --open"
echo '```'
} >> "$GITHUB_STEP_SUMMARY"
else
write_output "No changelog changes"
fi
Expand Down
Loading