Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vmaerten committed May 11, 2024
1 parent dbd8e2d commit 4f85e85
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 20 deletions.
2 changes: 1 addition & 1 deletion taskfile/node_git.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (
"github.com/go-task/task/v3/internal/filepathext"
)

// An GitNode is a node that reads a Taskfile from a remote location via HTTP.
// An GitNode is a node that reads a Taskfile from a remote location via Git.
type GitNode struct {
*BaseNode
URL *url.URL
Expand Down
18 changes: 0 additions & 18 deletions testdata/git/Taskfile.yml

This file was deleted.

4 changes: 3 additions & 1 deletion website/docs/experiments/remote_taskfiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,13 @@ includes:

## Git nodes

You can also include a Taskfile from a Git node. We currently support only "scp-style" addresses like `[email protected]/foo/bar?ref=v1//Taskfiles.yml`
You can also include a Taskfile from a Git node. We currently support ssh-style and http / https addresses like `[email protected]/foo/bar?ref=v1//Taskfiles.yml` and `https://example.com/foo/bar.git?ref=v1//Taskfiles.yml`.

You need to follow this pattern : `<baseUrl>.git?ref=<ref>//<path>`.
The `ref` parameter can be a branch name or a tag, and the `path` is the path to the Taskfile in the repository.

If you want to use the SSH protocol, you need to make sure that your ssh-agent has your private ssh keys added so that they can be used during authentication.

## Security

Running commands from sources that you do not control is always a potential
Expand Down

0 comments on commit 4f85e85

Please sign in to comment.