Skip to content

v2.0.0

Compare
Choose a tag to compare
@martinbaillie martinbaillie released this 12 Oct 09:25
· 19 commits to master since this release
v2.0.0
8d0472f

With this release, the plugin is moving to a model where it can support multiple GitHub App installations from the one mount. It does this in v2 by moving the configuration of GitHub App installation IDs (installation_id) to request time rather than configuration time.

Users can provide the installation_id as part of ad-hoc requests to the /token endpoint but are encouraged instead to utilise the powerful Permission Sets feature to persist and abstract away the installation_id parameter from the user entirely. By creating a permission set you only need to enter the installation_id once.

For convenience and to support another use case, the token and permission set endpoints can alternatively take an org_name value instead of an installation_id. In this case, the plugin will perform an additional lookup (roundtrip to your GitHub instance) against org_name to discover the current installation_id first during token creation flows. Note that there is no caching of the discovered installation_id so this extra lookup occurs every time. For high traffic mounts or permission sets you may wish to continue setting installation_id instead of org_name.

Breaking Changes:

  • Installation ID configuration is moved to request time. Permission Sets strongly encouraged.