aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/usage
diff options
context:
space:
mode:
authorKyle D <kdumontnu@gmail.com>2023-06-20 17:14:47 -0400
committerGitHub <noreply@github.com>2023-06-20 21:14:47 +0000
commit8220e50b56cf7bf9cdfff29a287c5721c3949464 (patch)
tree67c9a607550159f0cada700343c8044d93e3fc21 /docs/content/doc/usage
parente50c3e8431972a41fc9792939956c3281b1b4810 (diff)
downloadgitea-8220e50b56cf7bf9cdfff29a287c5721c3949464.tar.gz
gitea-8220e50b56cf7bf9cdfff29a287c5721c3949464.zip
Substitute variables in path names of template repos too (#25294)
### Summary Extend the template variable substitution to replace file paths. This can be helpful for setting up log files & directories that should match the repository name. ### PR Changes - Move files matching glob pattern when setting up repos from template - For security, added ~escaping~ sanitization for cross-platform support and to prevent directory traversal (thanks @silverwind for the reference) - Added unit testing for escaping function - Fixed the integration tests for repo template generation by passing the repo_template_id - Updated the integration testfiles to add some variable substitution & assert the outputs I had to fix the existing repo template integration test and extend it to add a check for variable substitutions. Example: ![image](https://github.com/go-gitea/gitea/assets/12700993/621feb09-0ef3-460e-afa8-da74cd84fa4e)
Diffstat (limited to 'docs/content/doc/usage')
-rw-r--r--docs/content/doc/usage/template-repositories.en-us.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/content/doc/usage/template-repositories.en-us.md b/docs/content/doc/usage/template-repositories.en-us.md
index 0c278648b3..5687861b8c 100644
--- a/docs/content/doc/usage/template-repositories.en-us.md
+++ b/docs/content/doc/usage/template-repositories.en-us.md
@@ -51,6 +51,8 @@ a/b/c/d.json
In any file matched by the above globs, certain variables will be expanded.
+Matching filenames and paths can also be expanded, and are conservatively sanitized to support cross-platform filesystems.
+
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 | Transformable |