Skip to content

Conversation

@karolswdev
Copy link
Owner

Summary

  • What does this change do? Aligns documentation with the current CLI and CI, adds
    a CI/Codecov guide, standardizes Go toolchain requirements, and removes aspirational
    references.
  • Why is it needed? Ensures accuracy, lowers friction for new contributors, and matches
    OSS expectations for clarity and reliability.

Changes

  • User-facing docs updated (README/docs)
  • Tests added/updated
  • CI green

Checklist

  • I read the Code of Conduct
  • I followed the contributing guidelines
  • I added a clear description and screenshots/logs if helpful

Notes

  • CI guide reflects codecov/codecov-action@v5 and coverage.txt aggregation flags.
  • If you prefer, I can add links to a specific release tag in the composite action
    example.

…overprofile=coverage.txt\n- Upload artifact and Codecov input as coverage.txt\n\nNo Jira ticket; routine CI maintenance change.
…from v4 to v5\n- Pass token via input and set slug\n- Rely on autodiscovery for coverage.txt
…ags before packages\n- Add -covermode=atomic and -coverpkg=./...\n- Stabilize single coverage.txt for artifact/Codecov
…\n- Fix CI/CD examples; add composite action + CLI variants\n- Add docs/CI.md with Codecov v5 guidance\n- Standardize branching to GitHub Flow\n- Replace gosec with govulncheck; remove aspirational links
@karolswdev karolswdev merged commit 8bdd311 into main Aug 31, 2025
1 check 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