Skip to content
New issue

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

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

Already on GitHub? # to your account

fix: remove @types/node from generated types #656

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Conversation

wolfy1339
Copy link
Member

See octokit/octokit.js#2762 (comment)

Resolves #ISSUE_NUMBER


Before the change?

  • Types would include a reference to @types/node even though there is nothing using Node specific APIs in the types

After the change?

  • Remove dependency on @types/node to make sure types are platform agnostic

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

@wolfy1339 wolfy1339 added the Type: Bug Something isn't working as documented, or is being fixed label Nov 20, 2024
Copy link
Contributor

👋 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 wolfy1339 merged commit 730a26d into main Nov 25, 2024
7 checks passed
@wolfy1339 wolfy1339 deleted the fix-types-deno branch November 25, 2024 23:35
@octokitbot
Copy link
Collaborator

🎉 This PR is included in version 13.6.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

newkdr added a commit to newkdr/vscode-gitlens that referenced this pull request Dec 18, 2024
![snyk-top-banner](https://github.com/andygongea/OWASP-Benchmark/assets/818805/c518c423-16fe-447e-b67f-ad5a49b5d123)


<h3>Snyk has created this PR to upgrade @octokit/types from 13.6.1 to
13.6.2.</h3>

:information_source: Keep your dependencies up-to-date. This makes it
easier to fix existing vulnerabilities and to more quickly identify and
fix newly disclosed vulnerabilities when they affect your project.

<hr/>


- The recommended version is **1 version** ahead of your current
version.

- The recommended version was released on **21 days ago**.



<details>
<summary><b>Release notes</b></summary>
<br/>
  <details>
    <summary>Package name: <b>@octokit/types</b></summary>
    <ul>
      <li>
<b>13.6.2</b> - <a
href="https://github.com/octokit/types.ts/releases/tag/v13.6.2">2024-11-25</a></br><h2><a
href="https://github.com/octokit/types.ts/compare/v13.6.1...v13.6.2">13.6.2</a>
(2024-11-25)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>remove <code>@ types/node</code> from generated types (<a
href="https://github.com/octokit/types.ts/issues/656"
data-hovercard-type="pull_request"
data-hovercard-url="/octokit/types.ts/pull/656/hovercard">gitkraken#656</a>) (<a
href="https://github.com/octokit/types.ts/commit/730a26dc2d919f19ed5401ffdf83286181da8772">730a26d</a>),
closes <a
href="https://github.com//github.com/octokit/octokit.js/issues/2762/issues/issuecomment-2486997620">/github.com/octokit/octokit.js/issues/2762#issuecomment-2486997620</a></li>
</ul>
      </li>
      <li>
<b>13.6.1</b> - <a
href="https://github.com/octokit/types.ts/releases/tag/v13.6.1">2024-10-03</a></br><h2><a
href="https://github.com/octokit/types.ts/compare/v13.6.0...v13.6.1">13.6.1</a>
(2024-10-03)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>restore CJS compat (<a
href="https://github.com/octokit/types.ts/issues/651"
data-hovercard-type="pull_request"
data-hovercard-url="/octokit/types.ts/pull/651/hovercard">gitkraken#651</a>) (<a
href="https://github.com/octokit/types.ts/commit/d66a6b99c1fe140fbc81afec442e14b4949926f0">d66a6b9</a>)</li>
</ul>
      </li>
    </ul>
from <a
href="https://github.com/octokit/types.ts/releases">@octokit/types
GitHub release notes</a>
  </details>
</details>

---

> [!IMPORTANT]
>
> - Check the changes in this PR to ensure they won't cause issues with
your project.
> - This PR was automatically created by Snyk using the credentials of a
real user.

---

**Note:** _You are seeing this because you or someone else with access
to this repository has authorized Snyk to open upgrade PRs._

**For more information:** <img
src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiJkNjAyYjg1OS02ODQwLTQ4NjItODlmZC1mMzVlM2ZiYjY4NjAiLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6ImQ2MDJiODU5LTY4NDAtNDg2Mi04OWZkLWYzNWUzZmJiNjg2MCJ9fQ=="
width="0" height="0"/>

> - 🧐 [View latest project
report](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 📜 [Customise PR
templates](https://docs.snyk.io/scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/customize-pr-templates?utm_source=&utm_content=fix-pr-template)
> - 🛠 [Adjust upgrade PR
settings](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 🔕 [Ignore this dependency or unsubscribe from future upgrade
PRs](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?pkg&#x3D;@octokit/types&amp;utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr#auto-dep-upgrades)

[//]: #
'snyk:metadata:{"customTemplate":{"variablesUsed":[],"fieldsUsed":[]},"dependencies":[{"name":"@octokit/types","from":"13.6.1","to":"13.6.2"}],"env":"prod","hasFixes":false,"isBreakingChange":false,"isMajorUpgrade":false,"issuesToFix":[],"prId":"d602b859-6840-4862-89fd-f35e3fbb6860","prPublicId":"d602b859-6840-4862-89fd-f35e3fbb6860","packageManager":"npm","priorityScoreList":[],"projectPublicId":"12a8a5f5-3e19-438c-8280-eb8f4ee06d17","projectUrl":"https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source=github&utm_medium=referral&page=upgrade-pr","prType":"upgrade","templateFieldSources":{"branchName":"default","commitMessage":"default","description":"default","title":"default"},"templateVariants":[],"type":"auto","upgrade":[],"upgradeInfo":{"versionsDiff":1,"publishedDate":"2024-11-25T23:36:35.481Z"},"vulns":[]}'
wolfy1339 added a commit to octokit/oauth-app.js that referenced this pull request Dec 28, 2024
For some reason, TypeScript is including references to `@types/node` in the generated types.

See octokit/types.ts#656
See octokit/octokit.js#2762 (comment)
wolfy1339 added a commit to octokit/oauth-app.js that referenced this pull request Dec 29, 2024
For some reason, TypeScript is including references to `@types/node` in the generated types.

See octokit/types.ts#656
See octokit/octokit.js#2762 (comment)
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
released Type: Bug Something isn't working as documented, or is being fixed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants