Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#74 Add Fetch command documentation #75

Merged
merged 2 commits into from
Sep 8, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,63 @@ Default value: `master`

The branch to pull from. E.g.: `master`, `develop` (optional).

## The "gitfetch" task

Download objects and refs from a repo.

### Overview

In your project's Gruntfile, add a section named `gitfetch` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
gitfetch: {
your_target: {
options: {
all: true
}
}
}
})
```

### Options

#### options.repository
Type: `String`
Default value: `null`

The repository you want to fetch from. When no remote is specified, by default the origin remote will be used.

#### options.all
Type: `Boolean`
Default value: `false`

Adds the `--all` flag. Fetch all remotes.

#### options.append
Type: `Boolean`
Default value: `false`

Adds the `--append` flag. Append ref names and object names of fetched refs.

#### options.prune
Type: `Boolean`
Default value: `false`

Adds the `--prune` flag. After fetching, remove any remote-tracking references that no longer exist on the remote.

#### options.notags
Type: `Boolean`
Default value: `false`

Adds the `--no-tags` flag. Disables automatic tag following.

#### options.tags
Type: `Boolean`
Default value: `false`

Adds the `--tags` flag. Fetch all tags from the remote into local.

## The "gitmerge" task

Expand Down