Conversation
- Add codecov token to coverage upload step in CI workflow - Add badges to README: CI status, Codecov coverage, license, Rust version, API docs - Reorganize examples section into categorized tables including previously unlisted examples (balance_checker, simulation, account_management, indexer_queries, event_queries) - Add architecture overview section with directory tree - Add link to API reference on GitHub Pages - Improve formatting with em dashes and tables for workspace layout Co-authored-by: Greg Nazario <greg@gnazar.io>
|
Cursor Agent can help with this pull request. Just |
There was a problem hiding this comment.
Pull request overview
Adds Codecov upload authentication and updates README content to improve project discoverability, including a coverage badge.
Changes:
- Adds Codecov coverage badge and refreshes README structure/content (features, examples, architecture).
- Updates CI workflow to provide
CODECOV_TOKENto the Codecov upload step.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds CI/Codecov badges and reorganizes documentation for clarity and discoverability. |
| .github/workflows/ci.yml | Supplies Codecov token to enable authenticated coverage uploads. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| - name: Upload coverage to Codecov | ||
| uses: codecov/codecov-action@v5 | ||
| with: | ||
| token: ${{ secrets.CODECOV_TOKEN }} | ||
| files: crates/aptos-sdk/target/coverage/cobertura.xml | ||
| flags: unittests | ||
| name: aptos-sdk-coverage |
There was a problem hiding this comment.
Providing secrets.CODECOV_TOKEN unconditionally can break CI for pull requests from forks (secrets are not available there), causing the upload step to fail. Consider either (a) omitting the token entirely if this repo can use Codecov tokenless uploads, or (b) gating the step/token usage with an if: condition that only runs uploads when secrets are available / when the PR originates from the same repository.
Add Codecov support and badge to the README, and refresh the README for improved clarity and discoverability.
The repository already had a Codecov configuration and CI job, but the upload step was missing the necessary token for authentication. This PR completes the setup and integrates the coverage badge into the refreshed README.