GitHub Repository Setup

GitHub Repository Setup

Configure your GitHub Enterprise repositories for use with Crodox.

---

Template Repository Requirement

Important: To use a GitHub repository with Crodox, it must be marked as a Template Repository in GitHub Enterprise.

---

Setting Up a Template Repository

Step 1 - Navigate to Repository Settings

1. Go to your GitHub Enterprise repository
2. Click Settings (gear icon)
3. Scroll to the General section

Step 2 - Enable Template Repository

1. Find the Template repository checkbox
2. Check the box to enable it
3. Click Save to apply the change

What this does:

• Marks the repository as a template
• Allows Crodox to use it for parsing and analysis
• Enables users to create repositories from this template structure

---

Why Template Repository?

Template repositories in GitHub Enterprise provide:

• A standardized starting point for new repositories
• Directory structure and file patterns that Crodox can parse
• Clear separation between template configuration and analyzed code

---

Using Template Repositories in Crodox

Once your repository is marked as a template:

1. Go to the Repositories tab in Crodox
2. Find your template repository in the list
3. Create a Workbench to analyze its structure
4. Use your Template grammar to parse the code

---

Troubleshooting

Issue: Repository doesn't appear in Crodox Repositories list

Solutions:

• Verify the repository is marked as a Template Repository in GitHub
• Check that the Crodox GitHub App has access to the repository
• Refresh the Repositories tab in Crodox

Issue: "Repository is not a template" error

Solution:

• Go to the repository Settings in GitHub
• Enable the Template repository checkbox
• Wait a few moments for GitHub to update
• Refresh Crodox

---

See also: GitHub App Installation - Install Crodox in GitHub · App-GitHub - Repository management