icon | description |
---|---|
link-simple |
Connect your Spice.ai app to a GitHub repository |
Before connecting:
- Admin access: Ensure you have administrative access to the GitHub repository. This level of access is required to install the Spice.ai GitHub app.
- Matching repository name: The Spice.ai app and the GitHub repository names must match. For example:
- Spice.ai app: spice.ai/spiceai/demo
- GitHub repository: github.com/spiceai/demo
To quickly set up a new repository, use the spiceai/spicepod-template as a starting point:
Creating a new repository using the template
{% hint style="warning" %} Make sure to copy app spicepod.yaml contents from the Code tab and place it in the root of the repository before linking. {% endhint %}
- Ensure the repository is set up as per instructions above.
- In the context of the Spice app to connect, navigate to Settings, then click the Connect repository button.
Connecting a Spice.ai app to a GitHub repository.
- Follow GitHub App installation instructions.
Ensure that you select all repositories or specifically the repository you intend to connect.
Installing the Spice.ai GitHub app.
- Finally, link the repository to your Spice.ai app.
Linking Spice.ai to GitHub repository