Skip to content

I19.10 · apisurface kind: a package's public API between versions #181

Open

Description

@adssib

Part of #171

Story

As a developer upgrading a package that has no changelog worth reading, I want patch-it to compare the package's public API between two releases, so removed and renamed functions, classes and parameters are known with no docs at all.

Subtasks

  • plugins/apisurface: ListVersions from the registry (PyPI first, then npm), ReadAt downloads the released artifact, Extract diffs the public surface of two versions
  • Python: public modules, classes, functions and their parameters from the wheel or sdist, without running the package's code
  • npm: exported names and signatures from the package's .d.ts files
  • Each event cites the artifact URL and the exact signature before and after
  • One source per SDK that already has an API source (the provider stories list them)

Acceptance criteria

  • A golden test per ecosystem over two saved releases of a real package
  • Private names (leading underscore, not exported) never produce events
  • No package code is executed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions