Skip to content

Add infrastructure to ensure our stable types remain stable #486

@flub

Description

@flub

noq generally is not 1.0 yet, so we do not guarantee much API stability. However some types are directly exported in iroh. We need to have infrastructure to protect against mistakes.

The types re-exported are already clearly documented in iroh/src/endpoint/quic.rs. We need to make sure we also clearly annotate this here to make sure they are not accidentally changed.

  • Each type needs to be clearly commented/documented that it is considered stable.
  • We need CI to check those types remain API stable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    Status

    🚑 Needs Triage

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions