diff options
| author | John Olheiser <42128690+jolheiser@users.noreply.github.com> | 2020-01-28 07:57:15 -0600 |
|---|---|---|
| committer | zeripath <art27@cantab.net> | 2020-01-28 13:57:15 +0000 |
| commit | 28216bde46a8cf415755ca41f3d58843eeb45e7c (patch) | |
| tree | a07282f9c102d0c4605094eeeb497453aa0dc36f /docs/content/doc/features | |
| parent | 206a031b38a766d0ce89ae94a304f7d418ccdafb (diff) | |
| download | gitea-28216bde46a8cf415755ca41f3d58843eeb45e7c.tar.gz gitea-28216bde46a8cf415755ca41f3d58843eeb45e7c.zip | |
More expansions in template repositories (#10021)
* Super expansion
* Explain which features are in 1.11 vs 1.12
* Move imports
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Diffstat (limited to 'docs/content/doc/features')
| -rw-r--r-- | docs/content/doc/features/gitea-directory.md | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/content/doc/features/gitea-directory.md b/docs/content/doc/features/gitea-directory.md deleted file mode 100644 index e598969bcd..0000000000 --- a/docs/content/doc/features/gitea-directory.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -date: "2019-11-28:00:00+02:00" -title: "The .gitea Directory" -slug: "gitea-directory" -weight: 40 -toc: true -draft: false -menu: - sidebar: - parent: "features" - name: "The .gitea Directory" - weight: 50 - identifier: "gitea-directory" ---- - -# The .gitea directory -Gitea repositories can include a `.gitea` directory at their base which will store settings/configurations for certain features. - -## Templates -Gitea includes template repositories, and one feature implemented with them is auto-expansion of specific variables within your template files. -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. - -### Example `.gitea/template` file -All paths are relative to the base of the repository -```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] -``` -**NOTE:** The `template` file will be removed from the `.gitea` directory when a repository is generated from the template. - -### Variable Expansion -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}` - -| Variable | Expands To | -|----------------------|-----------------------------------------------------| -| 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_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 | |