Fork the Example Target

The target repository is the project where you want to apply the template and automate tasks using the Sombra GitHub App. In this guide, we’ll walk you through the process of forking an example target repository from the SombraHQ GitHub organization. This will allow you to see how Sombra automates tasks and integrates templates into your projects.

Find the Target Repository

Navigate to the example target repository provided by SombraHQ:

Repository URL: sombrahq/playground-django-api-test

This repository is a minimal Django API project that we’ll use to demonstrate how the Sombra GitHub App applies templates.

Fork the Repository

Click the Fork Button:
- On the repository page, click the Fork button located at the top-right corner.
Select Your Account:
- Choose your personal GitHub account or your organization’s account where you want the forked repository to reside.
  - Personal Account: If you’re experimenting individually.
  - Organization Account: If you’re setting up Sombra for your team or company.

Edit the `sombra.yaml` File

After forking the repository, you’ll need to configure the sombra.yaml file to specify how the Sombra GitHub App should apply templates to your project.

Locate the sombra.yaml File:
- In your forked repository, find the sombra.yaml file at the root directory.
Edit the File:
- Click on the sombra.yaml file to open it.
- Click the Edit button (pencil icon) to modify the file.
Update the Template and Variables:
- Replace the template name to the full name of your current repository.
  For example, from sombrahq/playground-django-api-template to my-cool-org/playground-django-api-template
- Replace the existing content with your desired configuration.
This in an example of how it could look like:
```
branch: sombra-app-template-install
templates:
  - name: cool-org/playground-django-api-template
    vars:
      project: Awesome Project
      author: Alex Smith
      email: alex.smith@example.com
      entity: Settings
```
Commit the Changes:
- After updating the file, scroll down to the Commit changes section.
- Enter a commit message, such as “Update sombra.yaml with project variables.”
- Choose Commit directly to the main branch.
- Click Commit changes.

Notes

Repository Access:
- The forked target repository must be public to allow the Sombra GitHub App to access it.
Same Organization Requirement:
- If you’re using an organization account, ensure that both the template and target repositories are under the same organization for Sombra to function correctly.
Template Variables:
- Customize the vars in the sombra.yaml file to tailor the template to your project’s needs.

Additional Resources

Learn About Sombra Templates:
- Visit the Sombra Engine Documentation to understand how templates work and how to create your own.

Fork the Example Template Install Sombra GitHub App