octokit / octokit.rb

Ruby toolkit for the GitHub API
http://octokit.github.io/octokit.rb/
MIT License
3.83k stars 1.13k forks source link

[DOCS]: README and yardocs refer to deleted method `#create_authorization` #1639

Closed danbernier closed 8 months ago

danbernier commented 9 months ago

Describe the need

I've been trying to generate an auth token via Octokit 7.2.0 using Octokit::Client#create_authorization, following the README and the yardocs hosted at octokit.github.io, which is linked to from the "About" section of the octokit repo.

I keep getting NoMethodErrors:

undefined method `create_authorization' for #<Octokit::Client:0x000000010da37718 ...> (NoMethodError)

According to git log -S create_authorization, that method was deleted in 017b0e3bc4aafed817142db3765d02e88d926228 as part of https://github.com/octokit/octokit.rb/pull/1494, to fix https://github.com/octokit/octokit.rb/issues/1429, because per @timrogers, "the APIs it exposes were deprecated back in 2020."

The yardocs' colophon indicates they're 5 years old:

Generated on Thu Aug 30 11:17:17 2018 by yard 0.9.16 (ruby-2.5.1).

I'll update the README to drop those references, but it would be great to also regenerate the yardocs (it looks like they're on the gh-pages branch? I don't know the process for pushing to it.)

Most broadly: what replaces create_authorization? Is there a way to generate an access token for a user on-the-fly? And what else in the README is stale?

SDK Version

Octokit.rb 7.2.0

API Version

No response

Relevant log output

No response

Code of Conduct

github-actions[bot] commented 9 months ago

👋 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 labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀