Parameter setup_url is missing from GitHub App Manifests

[blakegearin]

Code of Conduct

• [X] I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/[email protected]/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest#github-app-manifest-parameters

What part(s) of the article would you like to see updated?

The "GitHub App Manifest parameters" section should be updated to include all possible parameters, including setup_url. I have verified it can be passed in and set accordingly, but it's not documented as far as I can tell. Others may fall into this category as well.

Additional information

Here's a comparison between the parameters listed in the manifest documentation versus the URL parameters documentation.

Parameter	URL parameters	Manifest parameters
name	✅	✅
description	✅	✅
url	✅	✅
callback_urls	✅	✅
public	✅	✅
request_oauth_on_install	✅	❌
setup_url	✅	❌
setup_on_update	✅	❌
webhook_active	✅	❌ see: hook_attributes
webhook_url	✅	❌ see: hook_attributes
hook_attributes	❌	✅
events	✅	❌ see: default_events
default_events	❌ see: events	✅
single_file_name	✅	❌
single_file_paths	✅	❌
redirect_url	❌	✅
default_permissions	❌ passed in as key-value pairs	✅

[welcome[bot]]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[cmwilson21]

@blakegearin Thank you for opening an issue and providing such clear detail. I'll get this triaged for review! 👀

[vgrl]

Thanks for opening up this issue @blakegearin! ⚡ An update to the GitHub App Manifest parameters table will help address confusion for our users. I suggest we update the table to include the setup_url paramater, with a type value of string, and a description of A full URL to redirect users to after they install your GitHub App if additional setup is required.

[blakegearin]

I haven't tried myself, but it seems likely that request_oauth_on_install and setup_on_update are also supported and undocumented manifest parameters.

[cmwilson21]

@blakegearin After talking with the team, we think you may be right. Would you mind testing them and/or opening up a new issue and include both of those in it? Then we can triage and track it ✨