The Framework for GitHub Apps on AWS is an open-source software development framework that uses AWS services to simplify the process of building and operating GitHub Apps.
Building and operating GitHub Apps securely and in keeping with best practices requires undifferentiated heavy lifting by every App builder. We want more people to build GitHub Apps. We want it to be simple for those Apps to adhere to best practices. We want GitHub App builders to be able to focus on the unique value that their Apps bring to their users.
The mechanism that we have chosen to deliver this capability is self-deployable infrastructure defined in AWS Cloud Development Kit (AWS CDK) Constructs that you can deploy in your applications. Some of these constructs build APIs that your business logic will need to call. We provide Smithy clients that you can use to call these APIs that you deploy. Finally, some of these components require manual setup which cannot be covered by AWS CDK constructs or automation. We provide operator tools which seek to simplify and standardize these manual tasks.
See the readme for each component for more information on how to get started with each.
- Credential Manager: This component keeps track of installations for one or more GitHub Apps and provides APIs that you can use to obtain GitHub credentials for each managed GitHub App and installation. Because every GitHub App that uses this framework is likely to need this component, it also includes some additional baseline functionality such as CloudWatch-based monitoring of GitHub API rate limits for each managed GitHub App installation.
- Operator Tools: Some operations, such as importing GitHub App JWT signing keys, cannot be automated at time of writing. This CLI tool seeks to simplify and standardize these manual tasks to reduce operator complexity and mitigate potential for error.
Do you have questions or need help? The best way to interact with our maintainers is through GitHub issues.
Please do not report security issues through GitHub issues. See our security policy for instructions on how to report security issues.
Do you want to help develop this framework? See our contributing guidelines for how to get started.
This project is licensed under the Apache-2.0 License.