magic_rb/forgejo
Template
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo synced 2024-11-30 05:46:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
forgejo/docs/content/doc/usage/template-repositories.en-us.md
Xinyu Zhou 563945c50c
Refactor docs (#21627) 
This patch:
- Rename some files( `.md` to `.en-us.md`), fix missed translation copy
- Update link which shoud be refer to `../hacking-on-gitea/` instead of
`../make/` (outdated)
- Update `_redirects`:
  -  redirect `/{zh-cn|fr-fr}/make/` to `../hacking-on-gitea/`
  - redirect `/zh-cn/third-party-tools/` to `/zh-cn/integrations/`
- Delete duplicated/outdated files.
- Update menu `weight` of developers.zh-cn.md

Signed-off-by: Xinyu Zhou <i@sourcehut.net>
2022-10-31 23:16:19 +00:00

3.2 KiB
Raw Blame History

date title slug weight toc draft menu
2019-11-28:00:00+02:00 Template Repositories template-repositories 14 false false
sidebar
parent name weight identifier
usage Template Repositories 14 template-repositories

Template Repositories

Table of Contents

{{< toc >}}

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.

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 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

# 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 Transformable
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 ✘

Transformers 🤖

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...

Transformer Effect
SNAKE go_sdk
KEBAB go-sdk
CAMEL goSdk
PASCAL GoSdk
LOWER go-sdk
UPPER GO-SDK
TITLE Go-Sdk