Skip to content

fix: exclude star-history API from lychee link checker#2029

Open
bearomorphism with Copilot wants to merge 2 commits into
masterfrom
copilot/fix-broken-links-report
Open

fix: exclude star-history API from lychee link checker#2029
bearomorphism with Copilot wants to merge 2 commits into
masterfrom
copilot/fix-broken-links-report

Conversation

Copilot AI commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

https://api.star-history.com/svg?repos=commitizen-tools/commitizen intermittently returns HTTP 500, causing the broken links CI check to fail. The service is externally owned and not in our control.

Description

Added https://api.star-history.com/ to the exclude list in lychee.toml to suppress false-positive broken link failures from this unreliable external service.

Checklist

Was generative AI tooling used to co-author this PR?

  • Yes (GitHub Copilot)

Code Changes

  • Add test cases to all the changes you introduce
  • Run uv run poe all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external)

Expected Behavior

The broken links CI check passes without flagging the star-history API image URL.

Steps to Test This Pull Request

  1. Trigger the broken links workflow — it should no longer report an error for https://api.star-history.com/svg?repos=commitizen-tools/commitizen.

Additional Context

The star-history widget in docs/README.md (line 308) embeds an SVG from api.star-history.com. That service is currently returning 500, which is out of our control. Excluding the domain prefix covers this and any future star-history embed variants.

Copilot AI linked an issue Jul 14, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix broken links in README.md report fix: exclude star-history API from lychee link checker Jul 14, 2026
Copilot AI requested a review from bearomorphism July 14, 2026 06:50
@bearomorphism bearomorphism marked this pull request as ready for review July 14, 2026 06:51
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Commitizen bump preview

Merging this PR will produce the following bump:

bump: version 4.16.4 → 4.16.5
tag to create: v4.16.5
increment detected: PATCH

@Lee-W Lee-W left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we could rebase and rewrite the commit history as ci: otherwise, it'll bump a patch version

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken Links Report

3 participants