Skip to content

Commit

Permalink
Document new branch pins
Browse files Browse the repository at this point in the history
  • Loading branch information
mosteo committed Jun 22, 2021
1 parent 0420a63 commit 6d20d5f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
7 changes: 5 additions & 2 deletions doc/catalog-format-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -535,11 +535,14 @@ The specific pin kinds and their attributes are:

For the common case of directories containing an Alire manifest, dependencies and pins will be included recursively in the build context.

* Pins to git repositories: the repository will be cloned locally and its directory will be used as in the previous case. Currently, this pin may optionally include a commit to fix the checkout to be used. Otherwise, the default branch will be used, and running `alr update` will refresh the checkout.
* Pins to git repositories: the repository will be cloned locally and its
* directory will be used as in the previous case. This pin may optionally
* include a commit to fix the checkout to be used, or a branch name to track. Otherwise, the default branch will be used, and running `alr update` will refresh the checkout.

* `url`: the URL of a git repository
* `commit` (optional): a complete git commit hash.
* `crate_name = { url = "https://my/repo.git" } # Updatable pin`
* `crate_name = { url = "https://my/repo.git" } # Updatable pin to default branch`
* `crate_name = { url = "https://my/repo.git", branch="feature" } # Updatable pin`
* `crate_name = { url = "https://my/repo.git", commit="abcdef..." } # Fixed pin`

### Using pins for crate testing
Expand Down
13 changes: 13 additions & 0 deletions doc/user-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ stay on top of `alr` new features.

## Release `1.1`

### Pins to git branches

PR [#754](https://github.com/alire-project/alire/pull/754)

A new option for remote pins exist to track branches:

```
[[pins]]
wip = { url = "https://gitrepo.com/wip.git" branch="feature" }
```

Running `alr update` will pull any changes from the branch.

### Pins stored in the manifest

PR [#743](https://github.com/alire-project/alire/pull/743).
Expand Down

0 comments on commit 6d20d5f

Please sign in to comment.