fix(package): add @octokit/core as peer dependency

[HeroicHitesh]

fixes #77

[HeroicHitesh]

@gr2m let me know if I need to remove type from index.ts as per the discussion here

[gr2m]

Thanks 👍🏼

[github-actions]

🎉 This PR is included in version 1.0.1 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[jakebrown58]

I was upgrading yarn packages today and got this warning:

warning "lerna > @lerna/version > @lerna/github-client > @octokit/rest > @octokit/[email protected]" has unmet peer dependency "@octokit/core@>=3".

[gr2m]

what @octokit/rest version do you use? Can you check if you have any @octokit/core version in your dependency tree at all?

[jakebrown58]

yea - lerna 3.22.1 - https://github.com/lerna/lerna/blob/master/package-lock.json
seems to be using octokit/rest 16.35.0.
though I don't see a reference to octokit/plugin-request-log in the package-lock.json here, which I expected to see.

(Thanks for responding- btw!)

[jakebrown58]

Ah - sorry: https://github.com/lerna/lerna/blob/master/utils/github-client/package.json
"dependencies": {
"@lerna/child-process": "file:../../core/child-process",
"@octokit/plugin-enterprise-rest": "^6.0.1",
"@octokit/rest": "^16.28.4",
"git-url-parse": "^11.1.2",
"npmlog": "^4.1.2"
}

My repo doesn't have any direct dependencies on octokit/core. It's getting brought in from lerna. I do not see a direct reference to octokit/core in their package.json or packaage-lock.json in the root.

[gr2m]

I see. So the problem here is that @octokit/rest v16 is not built upon @octokit/core. But this plugin utilizes types from @octokit/core.

I think you can probably suppress the warning by installing @octokit/core as dev dependency. But the proper fix would be to upgrade @octokit/rest to the latest version. Upgrade to v17 first: https://github.com/octokit/rest.js/releases/v17.0.0, address all deprecation messages, then upgrade to v18: https://github.com/octokit/rest.js/releases/v18.0.0

[jakebrown58]

Seems to be an issue on lerna's end then, wouldn't you say? The warning isn't that big of a deal to me. I mistakenly thought it was blocking me, though turned out to be something else.

[gr2m]

I'd say the warning is legit, but in this case safe to ignore. It's only about types anyway, it won't affect your code in production.