Skip to content

private_key attribute removal from the Auth objects is a breaking change, not a feature #3210

@webknjaz

Description

@webknjaz

Hello, I wrote some tests against a thing that uses PyGitHub, where I was spying on the Auth objects being passed around and accessing the value of the private_key for a sanity check in tests.

Those tests suddenly started failing with AttributeError: 'AppAuth' object has no attribute 'private_key' on Saturday. So I had to diff the CI run job logs between the failing and passing one, only to find out that a new version of PyGitHub got released. It hasn't yet made its way into the lock file, being in a PR.

I looked for breaking changes @ https://pygithub.rtfd.io/en/latest/changes.html#version-2-6-0-february-15-2025 and haven't seen anything related. It wasn't until I've reached the new features section when I finally saw the PR breaking it — #3065.

Apparently, in addition to adding new features, it also breaks public API.

I suggest adding an entry about this to the breaking changes section of the change log.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions