Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
zkochan committed Sep 23, 2023
1 parent 9acefe6 commit 090c39d
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/git_branch_lockfiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,13 @@ be `pnpm-lock.feature-1.yaml`. You can commit it to the Git, and merge all git b
|- pnpm-lock.<branch_name>.yaml
```

NOTE: `feature/1` is special in that the `/` is automatically converted to `!`, so the corresponding
:::note

`feature/1` is special in that the `/` is automatically converted to `!`, so the corresponding
lockfile name would be `pnpm-lock.feature!1.yaml`.

:::

## Merge git branch lockfiles

### `pnpm install --merge-git-branch-lockfiles`
Expand All @@ -39,14 +43,12 @@ After that, all git branch lockfiles will be merged into one `pnpm-lock.yaml`

### Branch Matching

Pnpm allows you to specify `--merge-git-branch-lockfiles` by matching the current branch name.
pnpm allows you to specify `--merge-git-branch-lockfiles` by matching the current branch name.

For instance,

By the following setting in `.npmrc` file, `pnpm install` will merge all git branch lockfiles when
For instance, by the following setting in `.npmrc` file, `pnpm install` will merge all git branch lockfiles when
running in the `main` branch and the branch name starts with `release`.

```ini
merge-git-branch-lockfiles-branch-pattern[]=main
merge-git-branch-lockfiles-branch-pattern[]=release*
```
```

0 comments on commit 090c39d

Please sign in to comment.