-
Notifications
You must be signed in to change notification settings - Fork 35
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
[FEAT] add getInstallationUrl
method
#542
[FEAT] add getInstallationUrl
method
#542
Conversation
👋 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 |
Question: how is the |
@gr2m yep, the state argument is preserved and passed to subsequent redirect urls (link to the docs). In my case, we request user oauth authorization during our installation step, so the state gets passed in the oauth redirect url |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great PR, thank you for the additional clarification in the README. Just one comment
@gr2m is there anything left to do on my side to get this merged? I'm unable to merge myself as I don't have write access |
🎉 This PR is included in version 15.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Resolves #541
Before the change?
GET /app
endpoint for getting the metadata for the current appAfter the change?
app.getInstallationUrl({ state, target_id })
method crafts the installation url for the userPull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!
Don't love how
getInstallationUrl
looks so similar togetInstallationOctokit
but "installation" means something different.octokit/oauth-methods.js
usesgetWebFlowAuthorizationUrl
butgetWebFlowInstallationUrl
seemed a little unnecessarily longThe other caveat is that the base url gets cached, so it won't update if someone updates the name of their github app while the program is running - not sure how common github app renames are