Skip to content

Fix spec-drift false positives from date-only description changes #49

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
splch merged 8 commits into from
May 27, 2026
Merged

Fix spec-drift false positives from date-only description changes #49

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
382bdc7
Initial plan
Copilot May 25, 2026
72b1ff4
fix: update vendored spec date and ignore date-only drifts in spec-dr…
Copilot May 25, 2026
87d6d29
fix: revert openapi.json date change — only spec-drift.yml needs upda…
Copilot May 25, 2026
e77159e
fix: simplify date-strip to inline sed on the existing one-liner
Copilot May 25, 2026
c5bd46a
fix: DRY up spec-drift diff step with norm() helper
Copilot May 25, 2026
a5f2fd4
fix: use perl -pe instead of sed in norm() helper
Copilot May 25, 2026
a6ef2cb
fix: use jq -S with inline gsub instead of python json.tool + perl
Copilot May 26, 2026
dbef7af
fix: replace gsub with del(.info.description) in norm()
Copilot May 26, 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
13 changes: 12 additions & 1 deletion .github/workflows/spec-drift.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,18 @@ jobs:
- name: Check for drift
id: drift
run: |
if ! diff -u --label vendored --label upstream <(python3 -m json.tool --sort-keys openapi.json) <(python3 -m json.tool --sort-keys /tmp/latest-spec.json) > /tmp/spec.diff; then
# Strip the "Last updated: <date>" line from the description before diffing
# so that date-only changes do not trigger a false positive.
strip_date() { python3 -c "
import json, re, sys
spec = json.load(sys.stdin)
if 'info' in spec and 'description' in spec['info']:
spec['info']['description'] = re.sub(r'\*Last updated:[^\n]*\*\n?', '', spec['info']['description'])
print(json.dumps(spec, sort_keys=True, indent=4))
"; }
if ! diff -u --label vendored --label upstream \
<(strip_date < openapi.json) \
<(strip_date < /tmp/latest-spec.json) > /tmp/spec.diff; then
echo "drifted=true" >> "$GITHUB_OUTPUT"
fi
- name: Open or update issue
Expand Down
2 changes: 1 addition & 1 deletion openapi.json
View file
Open in desktop

Large diffs are not rendered by default.