Skip to content

Commit

Permalink
update docs for better displaying subgroup support
Browse files Browse the repository at this point in the history
  • Loading branch information
loreanvictor committed Sep 6, 2024
1 parent c091010 commit 0fa4669
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,14 @@ tmplr owner/repo/subdirectory # 👉 sub directory

> 📖 Read more about command line options [here](cli.md).
<br>

> [!TIP]
> For cloning [gitlab subgroups](https://docs.gitlab.com/ee/user/group/subgroups/), use the `--subgroup` flag:
> ```bash
> tmplr gitlab:dude/fun-projects/starter-recipe --subgroup
> ```
<br/>
## Running Recipes
Expand Down Expand Up @@ -941,6 +949,7 @@ steps:
> <expression>
> to?:
> <expression>
> subgroup?: <boolean>
> ```
Copies contents of given repository into specified folder (using [degit](https://github.com/Rich-Harris/degit)). If destination is not specified, will copy into the same folder as the running recipe. Accepts the same sources as `tmplr` command.
```yml
Expand All @@ -951,6 +960,11 @@ steps:
```
<br/>

> [!TIP]
> For cloning [gitlab subgroups](https://docs.gitlab.com/ee/user/group/subgroups/), use the `subgroup` option.

<br/>

#### Run
> _Command_
> ```yml
Expand Down
9 changes: 9 additions & 0 deletions cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Copies content of given repository on GitHub to current directory, and runs its
tmplr gitlab:owner/repo
tmplr [email protected]:owner/repo
tmplr https://gitlab.com/owner/repo
tmplr gitlab:owner/group/repo --subgroup

# 🪣 download from BitBucket
tmplr bitbucket:owner/repo
Expand All @@ -44,6 +45,14 @@ tmplr owner/repo/subdirectory # 👉 sub directory

<br>

> [!TIP]
> For cloning [gitlab subgroups](https://docs.gitlab.com/ee/user/group/subgroups/), use the `--subgroup` flag:
> ```bash
> tmplr gitlab:dude/fun-projects/starter-recipe --subgroup
> ```
<br>
### Working directory
Use `-d` or `--dir` option to specify a working directory. **`tmplr`** will copy the repository to the given directory (creating all necessary directories) and runs the recipe from there:
Expand Down

0 comments on commit 0fa4669

Please sign in to comment.