next: v4 release tracker

mkungla commented 7 months ago

Description

This PR initiates the development of koios-go-client version 4, aimed at integrating all changes from Koios API v1.

Development Details

Branch for v4 Development: Check out the v4-dev branch for ongoing work.
Contribution Guide: Direct your PRs for v4 to the v4-dev branch.
Import Path for Testing: Use go get -u github.com/cardano-community/koios-go-client/v4@v4-dev for the latest commits or specific pre-releases like go get github.com/cardano-community/koios-go-client/v4@v4.0.0-alpha.1.

Implementation Task List

Below is a task list to track the progress of key implementation changes for v4:

[x] Update all client methods to align with Koios API v1 changes.
[x] Implement new endpoints introduced in Koios API v1.
[x] Address all breaking changes from API v0 to v1.
[ ] Add unit tests for new features and endpoints.
[ ] Update documentation to reflect v4 usage and API changes.

Testing and Feedback

This PR serves as the primary tracker for v4 release discussions and updates.
Relying on direct contributions and feedback from our small but active developer community. Let's work together to ensure v4 is solid and ready for release.

Context and Motivation

Transitioning to v4 to support Koios API v1 introduces necessary breaking changes and new features, ensuring our library remains up-to-date and functional for all users.

Fixes and Features

Fixes issues related to API v0 -> v1 transition.
Adds support for all new Koios v1 API endpoints.

How to Contribute

For any changes or additions, branch off from v4-dev, and ensure your PRs target this branch.
For testing, either pull directly from v4-dev or use the specified pre-release tags.

codecov[bot] commented 7 months ago

Codecov Report

Attention: Patch coverage is 4.16667% with 69 lines in your changes are missing coverage. Please review.

Project coverage is 11.44%. Comparing base (87385b6) to head (453fefc).

:exclamation: Current head 453fefc differs from pull request most recent head 809415b. Consider uploading reports for the commit 809415b to get more accurate results

Files	Patch %	Lines
network.go	0.00%	54 Missing :warning:
koios.go	0.00%	15 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #48 +/- ## ========================================== - Coverage 11.67% 11.44% -0.24% ========================================== Files 14 14 Lines 1396 1442 +46 ========================================== + Hits 163 165 +2 - Misses 1227 1271 +44 Partials 6 6 ``` | [Flag](https://app.codecov.io/gh/cardano-community/koios-go-client/pull/48/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cardano-community) | Coverage Δ | | |---|---|---| | [linux](https://app.codecov.io/gh/cardano-community/koios-go-client/pull/48/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cardano-community) | `?` | | | [local](https://app.codecov.io/gh/cardano-community/koios-go-client/pull/48/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cardano-community) | `11.44% <4.16%> (-0.24%)` | :arrow_down: | | [macos](https://app.codecov.io/gh/cardano-community/koios-go-client/pull/48/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cardano-community) | `?` | | | [windows](https://app.codecov.io/gh/cardano-community/koios-go-client/pull/48/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cardano-community) | `11.44% <4.16%> (-0.24%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cardano-community#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-advanced-security[bot] commented 7 months ago

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

cardano-community / koios-go-client