Skip to content
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

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

Closed
1 task done
danbernier opened this issue Oct 19, 2023 · 1 comment · Fixed by #1640
Closed
1 task done

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

danbernier opened this issue Oct 19, 2023 · 1 comment · Fixed by #1640
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation

Comments

@danbernier
Copy link
Contributor

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 017b0e3 as part of #1494, to fix #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

  • I agree to follow this project's Code of Conduct
@danbernier danbernier added Status: Triage This is being looked at and prioritized Type: Documentation Improvements or additions to documentation labels Oct 19, 2023
@github-actions
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 labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

danbernier added a commit to danbernier/octokit.rb that referenced this issue Oct 19, 2023
@kfcampbell kfcampbell added Status: Up for grabs Issues that are ready to be worked on by anyone and removed Status: Triage This is being looked at and prioritized labels Oct 23, 2023
@kfcampbell kfcampbell moved this from 🆕 Triage to 🔥 Backlog in 🧰 Octokit Active Oct 23, 2023
kfcampbell pushed a commit that referenced this issue Oct 27, 2023
@github-project-automation github-project-automation bot moved this from 🔥 Backlog to ✅ Done in 🧰 Octokit Active Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants