summaryrefslogtreecommitdiffstats
path: root/docs/content
diff options
context:
space:
mode:
authorJohn Olheiser <42128690+jolheiser@users.noreply.github.com>2019-11-30 00:54:47 -0600
committertechknowlogick <techknowlogick@gitea.io>2019-11-30 01:54:47 -0500
commit15a5c10d33fd3c0b9483316b19712e981bf2391d (patch)
tree5eb71ae48739e3f3f0f1e36a5e81b71d3d4e37b0 /docs/content
parentc9d50bcab56780fc26ca69cc72197e62bdb02134 (diff)
downloadgitea-15a5c10d33fd3c0b9483316b19712e981bf2391d.tar.gz
gitea-15a5c10d33fd3c0b9483316b19712e981bf2391d.zip
Variable expansion in repository templates (#9163)
* Start expansion Signed-off-by: jolheiser <john.olheiser@gmail.com> * _template rather than .template Signed-off-by: jolheiser <john.olheiser@gmail.com> * Use ioutil Signed-off-by: jolheiser <john.olheiser@gmail.com> * Add descriptions to mapping * Start globbing Signed-off-by: jolheiser <john.olheiser@gmail.com> * Tune globbing Signed-off-by: jolheiser <john.olheiser@gmail.com> * Re-arrange imports Signed-off-by: jolheiser <john.olheiser@gmail.com> * Don't expand git hooks Signed-off-by: jolheiser <john.olheiser@gmail.com> * Add glob tests for .giteatemplate Signed-off-by: jolheiser <john.olheiser@gmail.com> * Parse globs separately so they can be tested more easily Signed-off-by: jolheiser <john.olheiser@gmail.com> * Change template location and add docs Signed-off-by: jolheiser <john.olheiser@gmail.com> * nit Signed-off-by: jolheiser <john.olheiser@gmail.com> * Update docs/content/doc/features/gitea-directory.md Co-Authored-By: guillep2k <18600385+guillep2k@users.noreply.github.com> * Update docs/content/doc/features/gitea-directory.md Co-Authored-By: guillep2k <18600385+guillep2k@users.noreply.github.com> * Add upper-lower case match Signed-off-by: jolheiser <john.olheiser@gmail.com> * Nits Signed-off-by: jolheiser <john.olheiser@gmail.com> * Update models/repo_generate.go Co-Authored-By: guillep2k <18600385+guillep2k@users.noreply.github.com>
Diffstat (limited to 'docs/content')
-rw-r--r--docs/content/doc/features/gitea-directory.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/content/doc/features/gitea-directory.md b/docs/content/doc/features/gitea-directory.md
new file mode 100644
index 0000000000..e598969bcd
--- /dev/null
+++ b/docs/content/doc/features/gitea-directory.md
@@ -0,0 +1,56 @@
+---
+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 |