Skip to content

First Release Roadmap #229

@devnatan

Description

@devnatan

To achieve our first stable release, we need to complete the following milestones:

Prerequisites

✔️ Acceptance Criteria

Coverage

  • Minimum 80% code coverage for all API endpoints
  • All container endpoints have integration tests
  • All system endpoints have integration tests
  • All image endpoints have integration tests

API Coverage Requirements

See SUPPORTED_ENDPOINTS.md for complete list

  • Cover all container-related endpoints
  • Cover all system-related endpoints
  • Ensure the following critical image operations are fully implemented: inspect, pull, removal, prune, list and search

Github Actions & Security

  • Integration Tests workflow working on Linux and macOS targets (the workflow, not tests)
  • Binary Compatibility Validator and Lint Codebase running on Pull Requests

Platform Support

  • JVM target fully functional
  • Native targets compile and pass tests (remember to set NATIVE_TESTS_ENABLED variable to true)

API Documentation

  • Public Dokka API reference
    Now available: https://docs.devnatan.me/docker-kotlin
  • KDoc comments for all public APIs
  • Include code examples for common use cases
  • Installation instructions for all supported platforms
  • Configuration guide (HttpClient setup, authentication, etc.)

Release Notes

  • Use Github Labels to create a compreensive changelog with explicit Breaking Changes section
  • Known limitations and workarounds

❌ Out of Scope for 1.0.0:

  • Interactive Session/WebSocket streaming endpoints
  • Swarm-related endpoints
  • Distribution endpoints
  • Interactive session endpoints

These out-of-scope features may be considered for future releases (1.1.0+).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions