Skip to content

Fix broken GitHub Actions badge URL in README.md #879

@camilamaia

Description

@camilamaia

⚠️ Reserved for Conference Tutorial

This issue is currently reserved for participants of a tutorial at PyCon DE & PyData 2026. It is part of a guided session, so contributions may be coordinated during the event. If the issue is not resolved during the tutorial, it will be reopened for general contributions afterward. Thank you for your understanding and interest in contributing 💜

Description

The GitHub Actions badge for the lint workflow in the README.md is currently not displaying correctly.

This happens because the badge URL is using an outdated format (/workflows/.../badge.svg) instead of the current recommended format (/actions/workflows/.../badge.svg).

Updating this URL will ensure the badge renders properly and reflects the workflow status.

Current Behavior

The badge is not displayed (broken image or not loading).

Current implementation

<a href="https://github.com/scanapi/scanapi/actions/workflows/lint.yml?query=branch%3Amain">
  <img alt="LintCheck" src="https://github.com/scanapi/scanapi/workflows/lint.yml/badge.svg?event=push">
</a>

Screenshot (current state)

Image

Expected Behavior

The badge should display correctly and show the current status of the workflow.

Expected implementation

<a href="https://github.com/scanapi/scanapi/actions/workflows/lint.yml?query=branch%3Amain">
  <img alt="LintCheck" src="https://github.com/scanapi/scanapi/actions/workflows/lint.yml/badge.svg?branch=main">
</a>

Screenshot (expected state)

Image

Why this matters

  • Ensures the README displays correctly
  • Improves visibility of CI status
  • Aligns with GitHub’s current badge URL format

Tasks

  • Open README.md
  • Locate the lint workflow badge
  • Replace the img src URL with the updated format
  • Verify that the badge renders correctly in GitHub

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentationGood First IssueGood for newcomers or first time contributors.PyCon DE 2026Issues marked with this label are specifically intended for participants of the PyCon DE tutorial.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions