Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 2, 2025

Adds ReadTheDocs and Code Coverage badges to README following the ezstitcher repository pattern.

Changes

  • README.md: Added ReadTheDocs status badge and Code Coverage badge alongside existing badges
  • .github/workflows/coverage-pages.yml: New workflow that runs tests with coverage, generates SVG badge via genbadge, commits badge to .github/badges/coverage.svg, and deploys HTML reports to GitHub Pages
  • .github/badges/coverage.svg: Placeholder badge (updated automatically by workflow)
  • SETUP_INSTRUCTIONS.md: Documents required manual steps

Manual Steps Required

After merge:

  1. Enable GitHub Pages: Settings > Pages > Source > "GitHub Actions"
  2. Update repo description: Add https://arraybridge.readthedocs.io as website URL

Notes

  • Coverage workflow runs independently on push to main; existing CI continues uploading to Codecov
  • .readthedocs.yml already configured correctly
  • Uses project's dev dependencies for version consistency

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/search/repositories
    • Triggering command: curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Can you also include code cov and rtd badges in the readme? make sure the rtd workflow is setup with link in repo description too. also setup code cov with badge like with the ezstitcher repo


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits November 2, 2025 19:51
Co-authored-by: trissim <56880052+trissim@users.noreply.github.com>
Co-authored-by: trissim <56880052+trissim@users.noreply.github.com>
Co-authored-by: trissim <56880052+trissim@users.noreply.github.com>
Copilot AI changed the title [WIP] Add code cov and RTD badges to README Add ReadTheDocs and Code Coverage badges to README Nov 2, 2025
Copilot AI requested a review from trissim November 2, 2025 19:58
@trissim trissim marked this pull request as ready for review November 2, 2025 20:27
@trissim trissim merged commit 235ed71 into main Nov 2, 2025
18 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants