Skip to content

docs: fix Python SDK build status badge - #756

Merged
gjtorikian merged 2 commits into
mainfrom
fix/doc-639-python-build-badge
Oct 20, 2026
Merged

gjtorikian merged 2 commits into
mainfrom
fix/doc-639-python-build-badge

Conversation

@workos-tars

@workos-tars workos-tars Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Description

Fixes DOC-639.

Replace the obsolete Semaphore build-status image and link in README.md with the repository's GitHub Actions CI badge and workflow page, both scoped to main. The broken Semaphore image is also embedded under WorkOS Python Library on the Python SDK docs page.

Documentation

This is a one-line README correction, not an SDK behavior change. The source badge is fixed here; the live docs page has not been updated or deployed by this PR.

Validation

  • Reproduced the live docs failure: the Build Status image finishes loading with naturalWidth === 0, while the adjacent PyPI badge loads.
  • Opened the replacement badge in a browser and verified that its SVG renders CI — passing.
  • Opened the replacement link and verified the CI workflow page with branch:main filtering.
  • Asserted that only the badge line changed, the referenced workflow exists, and no Semaphore URL remains in the README.
  • git diff --check passes.
  • No local Python test suite run: this changes only a Markdown image/link. Repository CI will run on the PR.

Visual verification

The README at commit 2f91321984410707e889f00c2ba7f2254af2ac6f renders the new badge successfully (naturalWidth: 90, naturalHeight: 20). This screenshot is from the changed README on GitHub, not a production docs deployment.

After: Python README with working GitHub Actions CI badge

Requested by kathleen.brandt@workos.com (best-known issue attribution; workflow execution, no employee action authority) in Linear

@workos-tars
workos-tars Bot requested review from a team as code owners October 20, 2026 17:49
@workos-tars
workos-tars Bot requested a review from gjtorikian October 20, 2026 17:49
@linear-code

linear-code Bot commented Oct 20, 2026

Copy link
Copy Markdown

DOC-639

@greptile-apps

greptile-apps Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR is safe to merge, but restoring the build-status badge would fulfill its stated purpose.

Findings

  1. P2 Build status is missing ▶
Fix with agent prompt
### Issue 1
README.md:4
The latest change deletes the working GitHub Actions badge instead of replacing the obsolete Semaphore badge as described. Readers of `README.md` can no longer see the build status or open the CI workflow. Restore the GitHub Actions badge and link scoped to `main`.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Summary

Removes the obsolete Semaphore badge from README.md.

  • The README no longer shows the Semaphore build-status badge.

Reviews (2) · Last reviewed commit: "Remove build status badge from README" · Reviewed by Greptile

Removed build status badge from README.md
@gjtorikian

Copy link
Copy Markdown
Contributor

executive decision: deleting the badge. never really liked these. like, we're not going to check in a version of this code that obviously breaks main.

@gjtorikian
gjtorikian merged commit 75dee0a into main Oct 20, 2026
13 checks passed
@gjtorikian
gjtorikian deleted the fix/doc-639-python-build-badge branch October 20, 2026 18:11
Comment thread README.md

![PyPI](https://img.shields.io/pypi/v/workos)
[![Build Status](https://workos.semaphoreci.com/badges/workos-python/branches/main.svg?style=shields&key=9e4cb5bb-86a4-4938-9ec2-fc9f9fc512be)](https://workos.semaphoreci.com/projects/workos-python)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Build status is missing

The latest change deletes the working GitHub Actions badge instead of replacing the obsolete Semaphore badge as described. Readers of README.md can no longer see the build status or open the CI workflow. Restore the GitHub Actions badge and link scoped to main.

Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 4

Comment:
**Build status is missing**

The latest change deletes the working GitHub Actions badge instead of replacing the obsolete Semaphore badge as described. Readers of `README.md` can no longer see the build status or open the CI workflow. Restore the GitHub Actions badge and link scoped to `main`.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant