What Happens Next?
After successfully installing the Sombra GitHub App and configuring your repositories, here’s what will happen:
GitHub Webhooks
Upon installation, the Sombra GitHub App receives webhooks for your selected repositories. These webhooks allow the app to know which repositories can be accessed.
- Secure and Specific: The app only receives events from repositories you’ve explicitly granted access to, maintaining your project’s security and integrity.
Scanning Public Repositories
The Sombra GitHub App scans the public repositories you’ve authorized to identify where it can apply automation and templates.
- Public Repositories Only: Currently, the app operates exclusively on public repositories. It will never scan, clone, or update any private repositories.
- Efficiency: By scanning your repositories, the app identifies opportunities to streamline tasks and maintain standardization.
Updating Repositories Using Sombra Engine
The Sombra Engine applies your selected templates to the target repositories, automating repetitive tasks and ensuring consistency.
Initial Pull Request Creation: The app creates a pull request in your target repository with the changes generated from the template.
- Review Before Merging: This allows you to review the proposed changes before integrating them into your codebase.
- Example Pull Request: See this example pull request to understand how the Sombra GitHub App integrates templates into a repository.
One-Time Update: Currently, the app performs a one-time update from the template to the target repository.
- Future Enhancements: We plan to support regular updates and synchronization between templates and repositories in future releases.
Notes
Same Organization Requirement: Only repositories within the same organization can be used as templates for new projects.
Feedback and Support: If you encounter any issues or have suggestions, please contact me or report an issue.
Thank you for using Sombra!