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

Document that clientId may be assigned to the appId property #635

Open
joebowbeer opened this issue Aug 9, 2024 · 1 comment
Open

Document that clientId may be assigned to the appId property #635

joebowbeer opened this issue Aug 9, 2024 · 1 comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation

Comments

@joebowbeer
Copy link

joebowbeer commented Aug 9, 2024

There are two places in the README that should mention that the clientId string can be assigned to the appId property, whose type is now number | string. In fact, providing the clientId string is now recommended.

  1. https://github.com/octokit/auth-app.js/tree/main?tab=readme-ov-file#createappauthoptions-or-new-octokit-auth-
  2. https://github.com/octokit/auth-app.js/tree/main?tab=readme-ov-file#json-web-token-jwt-authentication-1

Originally posted by @gr2m in #606 (comment)

Copy link
Contributor

github-actions bot commented Aug 9, 2024

👋 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! 🚀

@joebowbeer joebowbeer changed the title Document that clientId may be assigned to appId properties Document that clientId may be assigned to the appId property Aug 9, 2024
@wolfy1339 wolfy1339 added Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation labels Aug 9, 2024
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
Status: 🔥 Backlog
Development

No branches or pull requests

2 participants