2019-11-30 07:54:47 +01:00
---
date: "2019-11-28:00:00+02:00"
2020-01-28 14:57:15 +01:00
title: "Template Repositories"
slug: "template-repositories"
weight: 14
2020-12-09 07:47:06 +01:00
toc: false
2019-11-30 07:54:47 +01:00
draft: false
menu:
sidebar:
2020-01-28 14:57:15 +01:00
parent: "usage"
name: "Template Repositories"
weight: 14
identifier: "template-repositories"
2019-11-30 07:54:47 +01:00
- --
2020-12-09 07:47:06 +01:00
# Template Repositories
**Table of Contents**
{{< toc > }}
2020-01-28 14:57:15 +01:00
Gitea `1.11.0` and above includes template repositories, and one feature implemented with them is auto-expansion of specific variables within your template files.
2019-11-30 07:54:47 +01:00
To tell Gitea which files to expand, you must include a `template` file inside the `.gitea` directory of the template repository.
Gitea uses [gobwas/glob ](https://github.com/gobwas/glob ) for its glob syntax. It closely resembles a traditional `.gitignore` , however there may be slight differences.
2020-12-09 07:47:06 +01:00
## Example `.gitea/template` file
2019-11-30 07:54:47 +01:00
All paths are relative to the base of the repository
2020-12-09 07:47:06 +01:00
2019-11-30 07:54:47 +01:00
```gitignore
# All .go files, anywhere in the repository
**.go
# All text files in the text directory
text/*.txt
# A specific file
a/b/c/d.json
# Batch files in both upper or lower case can be matched
**.[bB][aA][tT]
```
2020-12-09 07:47:06 +01:00
2019-11-30 07:54:47 +01:00
**NOTE:** The `template` file will be removed from the `.gitea` directory when a repository is generated from the template.
2020-12-09 07:47:06 +01:00
## Variable Expansion
2019-11-30 07:54:47 +01:00
In any file matched by the above globs, certain variables will be expanded.
All variables must be of the form `$VAR` or `${VAR}` . To escape an expansion, use a double `$$` , such as `$$VAR` or `$${VAR}`
2020-01-28 14:57:15 +01:00
| Variable | Expands To | Transformable |
2020-12-09 07:47:06 +01:00
| -------------------- | --------------------------------------------------- | ------------- |
2020-01-28 14:57:15 +01:00
| REPO_NAME | The name of the generated repository | ✓ |
| TEMPLATE_NAME | The name of the template repository | ✓ |
| REPO_DESCRIPTION | The description of the generated repository | ✘ |
| TEMPLATE_DESCRIPTION | The description of the template repository | ✘ |
| REPO_OWNER | The owner of the generated repository | ✓ |
| TEMPLATE_OWNER | The owner of the template repository | ✓ |
| REPO_LINK | The URL to the generated repository | ✘ |
| TEMPLATE_LINK | The URL to the template repository | ✘ |
| REPO_HTTPS_URL | The HTTP(S) clone link for the generated repository | ✘ |
| TEMPLATE_HTTPS_URL | The HTTP(S) clone link for the template repository | ✘ |
| REPO_SSH_URL | The SSH clone link for the generated repository | ✘ |
| TEMPLATE_SSH_URL | The SSH clone link for the template repository | ✘ |
2020-12-09 07:47:06 +01:00
## Transformers :robot:
2020-01-28 14:57:15 +01:00
Gitea `1.12.0` adds a few transformers to some of the applicable variables above.
For example, to get `REPO_NAME` in `PASCAL` -case, your template would use `${REPO_NAME_PASCAL}`
Feeding `go-sdk` to the available transformers yields...
2020-12-09 07:47:06 +01:00
| Transformer | Effect |
| ----------- | ------ |
| SNAKE | go_sdk |
| KEBAB | go-sdk |
| CAMEL | goSdk |
| PASCAL | GoSdk |
| LOWER | go-sdk |
| UPPER | GO-SDK |
| TITLE | Go-Sdk |