Skip to content

[BUG]: octokit is missing its @octokit/webhooks dependency #2844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
orionmiz opened this issue May 10, 2025 · 3 comments · Fixed by #2847
Closed
1 task done

[BUG]: octokit is missing its @octokit/webhooks dependency #2844

orionmiz opened this issue May 10, 2025 · 3 comments · Fixed by #2847
Labels
released on @4.x released Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented

Comments

@orionmiz
Copy link

orionmiz commented May 10, 2025

What happened?

webhooks property type of App cannot be resolved when using Yarn's Plug'n'Play mode.

Here's dist-types/app.d.ts in [email protected]:

import { App as DefaultApp } from "@octokit/app";
import { OAuthApp as DefaultOAuthApp } from "@octokit/oauth-app";
export declare const App: (new (...args: any[]) => {
    // ...
    webhooks: import("@octokit/webhooks").Webhooks<{ // this property resolves its type as `any`.
        octokit: import("@octokit/core").Octokit & {
            paginate: import("@octokit/plugin-paginate-rest").PaginateInterface;
        } & import("@octokit/plugin-paginate-graphql").paginateGraphQLInterface & import("@octokit/plugin-rest-endpoint-methods").Api & {
            retry: {
                retryRequest: (error: import("@octokit/request-error").RequestError, retries: number, retryAfter: number) => import("@octokit/request-error").RequestError;
            };
        };
    }>;
    // ...
}) & typeof DefaultApp;

It's a typical ghost dependency problem; Exported App type requires dependencies from @octokit/app to be specified in octokit's dependencies as well though it's just exporting the types, not actual module.

Here's a workaround for pnp users like me:

packageExtensions:
  octokit@*:
    dependencies:
      "@octokit/webhooks": "*"

Versions

octokit@npm:4.1.3

Code of Conduct

  • I agree to follow this project's Code of Conduct
@orionmiz orionmiz added Type: Bug Something isn't working as documented Status: Triage This is being looked at and prioritized labels May 10, 2025
Copy link

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

wolfy1339 added a commit that referenced this issue May 12, 2025
Because of the way that the types are defined, the `App` class definition created with `App#defaults()` contains references to `@octokit/webhooks`.

Adds an explicit dependency on `@octokit/webhooks` to avoid any issue for consumers.

Fixes #2844
wolfy1339 added a commit that referenced this issue May 20, 2025
Because of the way that the types are defined, the `App` class definition created with `App#defaults()` contains references to `@octokit/webhooks`.

Adds an explicit dependency on `@octokit/webhooks` to avoid any issue for consumers.

Fixes #2844
@github-project-automation github-project-automation bot moved this from 🆕 Triage to ✅ Done in 🧰 Octokit Active May 20, 2025
Copy link

🎉 This issue has been resolved in version 5.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

wolfy1339 added a commit that referenced this issue May 20, 2025
Because of the way that the types are defined, the `App` class definition created with `App#defaults()` contains references to `@octokit/webhooks`.

Adds an explicit dependency on `@octokit/webhooks` to avoid any issue for consumers.

Fixes #2844
Copy link

🎉 This issue has been resolved in version 4.1.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

wolfy1339 added a commit that referenced this issue May 20, 2025
* Adds explicit dependency on @octokit/webhooks, #2844
* Bumps @octokit/plugin-paginate-rest to address a ReDOS vulnerability
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue May 24, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 5.0.2 |


## [v5.0.2](https://github.com/octokit/octokit.js/releases/tag/v5.0.2)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2853](octokit/octokit.js#2853)) ([edfce61](octokit/octokit.js@edfce61))


## [v5.0.1](https://github.com/octokit/octokit.js/releases/tag/v5.0.1)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([2b5ed09](octokit/octokit.js@2b5ed09)), closes [#2844](octokit/octokit.js#2844)


## [v5.0.0](https://github.com/octokit/octokit.js/releases/tag/v5.0.0)

##### Continuous Integration

-   stop testing against NodeJS v18 ([#2846](octokit/octokit.js#2846)) ([8ec7ed7](octokit/octokit.js@8ec7ed7))

##### BREAKING CHANGES

-   Drop support for NodeJS v18

-   ci: stop testing against NodeJS v18


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue May 24, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 5.0.2 |


## [v5.0.2](https://github.com/octokit/octokit.js/releases/tag/v5.0.2)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2853](octokit/octokit.js#2853)) ([edfce61](octokit/octokit.js@edfce61))


## [v5.0.1](https://github.com/octokit/octokit.js/releases/tag/v5.0.1)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([2b5ed09](octokit/octokit.js@2b5ed09)), closes [#2844](octokit/octokit.js#2844)


## [v5.0.0](https://github.com/octokit/octokit.js/releases/tag/v5.0.0)

##### Continuous Integration

-   stop testing against NodeJS v18 ([#2846](octokit/octokit.js#2846)) ([8ec7ed7](octokit/octokit.js@8ec7ed7))

##### BREAKING CHANGES

-   Drop support for NodeJS v18

-   ci: stop testing against NodeJS v18


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue May 24, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 4.1.4 |


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue May 25, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 5.0.2 |


## [v5.0.2](https://github.com/octokit/octokit.js/releases/tag/v5.0.2)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2853](octokit/octokit.js#2853)) ([edfce61](octokit/octokit.js@edfce61))


## [v5.0.1](https://github.com/octokit/octokit.js/releases/tag/v5.0.1)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([2b5ed09](octokit/octokit.js@2b5ed09)), closes [#2844](octokit/octokit.js#2844)


## [v5.0.0](https://github.com/octokit/octokit.js/releases/tag/v5.0.0)

##### Continuous Integration

-   stop testing against NodeJS v18 ([#2846](octokit/octokit.js#2846)) ([8ec7ed7](octokit/octokit.js@8ec7ed7))

##### BREAKING CHANGES

-   Drop support for NodeJS v18

-   ci: stop testing against NodeJS v18


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue May 25, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 4.1.4 |


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue May 31, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 5.0.3 |


## [v5.0.3](https://github.com/octokit/octokit.js/releases/tag/v5.0.3)

##### Bug Fixes

-   **deps:** update dependency [@octokit/plugin-rest-endpoint-methods](https://github.com/octokit/plugin-rest-endpoint-methods) to v16 ([#2855](octokit/octokit.js#2855)) ([310e4cb](octokit/octokit.js@310e4cb))


## [v5.0.2](https://github.com/octokit/octokit.js/releases/tag/v5.0.2)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2853](octokit/octokit.js#2853)) ([edfce61](octokit/octokit.js@edfce61))


## [v5.0.1](https://github.com/octokit/octokit.js/releases/tag/v5.0.1)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([2b5ed09](octokit/octokit.js@2b5ed09)), closes [#2844](octokit/octokit.js#2844)


## [v5.0.0](https://github.com/octokit/octokit.js/releases/tag/v5.0.0)

##### Continuous Integration

-   stop testing against NodeJS v18 ([#2846](octokit/octokit.js#2846)) ([8ec7ed7](octokit/octokit.js@8ec7ed7))

##### BREAKING CHANGES

-   Drop support for NodeJS v18

-   ci: stop testing against NodeJS v18


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue May 31, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 4.1.4 |


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue Jun 1, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 5.0.3 |


## [v5.0.3](https://github.com/octokit/octokit.js/releases/tag/v5.0.3)

##### Bug Fixes

-   **deps:** update dependency [@octokit/plugin-rest-endpoint-methods](https://github.com/octokit/plugin-rest-endpoint-methods) to v16 ([#2855](octokit/octokit.js#2855)) ([310e4cb](octokit/octokit.js@310e4cb))


## [v5.0.2](https://github.com/octokit/octokit.js/releases/tag/v5.0.2)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2853](octokit/octokit.js#2853)) ([edfce61](octokit/octokit.js@edfce61))


## [v5.0.1](https://github.com/octokit/octokit.js/releases/tag/v5.0.1)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([2b5ed09](octokit/octokit.js@2b5ed09)), closes [#2844](octokit/octokit.js#2844)


## [v5.0.0](https://github.com/octokit/octokit.js/releases/tag/v5.0.0)

##### Continuous Integration

-   stop testing against NodeJS v18 ([#2846](octokit/octokit.js#2846)) ([8ec7ed7](octokit/octokit.js@8ec7ed7))

##### BREAKING CHANGES

-   Drop support for NodeJS v18

-   ci: stop testing against NodeJS v18


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this issue Jun 1, 2025
| datasource | package | from  | to    |
| ---------- | ------- | ----- | ----- |
| npm        | octokit | 4.1.2 | 4.1.4 |


## [v4.1.4](https://github.com/octokit/octokit.js/releases/tag/v4.1.4)

##### Bug Fixes

-   **deps:** add explicit dependency on `@octokit/webhooks` ([#2847](octokit/octokit.js#2847)) ([3589cd2](octokit/octokit.js@3589cd2)), closes [#2844](octokit/octokit.js#2844)


## [v4.1.3](https://github.com/octokit/octokit.js/releases/tag/v4.1.3)

##### Bug Fixes

-   **deps:** update octokit monorepo (major) ([#2836](octokit/octokit.js#2836)) ([4ccc6d3](octokit/octokit.js@4ccc6d3))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released on @4.x released Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

1 participant