tbroadley / github-spellcheck-cli

Check a GitHub repository for spelling mistakes and automatically create a pull request :pen:
MIT License
135 stars 14 forks source link

Changing repo() function call to createRepo() due to deprecation warnings #87

Closed Smittey closed 5 years ago

Smittey commented 5 years ago

On running the module I received the following warning from @octokit/rest:

DEPRECATED (@octokit/rest): repos.fork() is deprecated, use repos.createFork()

This PR contains an upgrade to the underlying @octokit/rest package and changing the fork() method call to createFork(). Additionally, the Authentication function then required updating to address the following deprecation warning:

Deprecation: [@octokit/rest] octokit.authenticate() is deprecated. Use "auth" constructor option instead.

As per the documentation here

Smittey commented 5 years ago

@tbroadley No problem! It's a nice project. Thanks for making it

The build seemed to fail trying to spell check the CHANGELOG and it failed on a github emoji that was already there from 2 years ago (:star :) - I saw there was some old issues around emojis. It was detecting it as (``).

I upgraded to use the current version of the cli and that didn't seem to fix it. After trying it a few times it began to work. Not sure what was happening in the background but it seemed slightly temperamental. It's working now though and seems to be building :)