Skip to content

Commit

Permalink
Deprecate default_path support in repoPaths configuration
Browse files Browse the repository at this point in the history
Now that we support the more general `:owner/:repo` template
configuration (85a75fe), the prior
`default_path` functionality (d9ef14a)
is redundant - e.g. this configuration:
```
default_path: ~/code/repos
```
can be achieved with:
```
:owner/:repo: ~/code/repos/:repo
```

Thus, we are deprecating the `default_path` syntax. It's still supported
but will be removed in the next major version.
  • Loading branch information
rmacklin committed Mar 4, 2024
1 parent 85a75fe commit 6446f52
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ defaults:
width: 60 # width in columns
refetchIntervalMinutes: 30 # will refetch all sections every 30 minutes
repoPaths: # configure where to locate repos when checking out PRs
default_path: ~/code/repos # fallback value if none of the other paths match
default_path: ~/code/repos # (deprecated) fallback parent directory if none of the other paths match
:owner/:repo: ~/src/github.com/:owner/:repo # template if you always clone github repos in a consistent location
dlvhdr/*: ~/code/repos/dlvhdr/* # will match dlvhdr/repo-name to ~/code/repos/dlvhdr/repo-name
dlvhdr/gh-dash: ~/code/gh-dash # will not match wildcard and map to specified path
Expand Down Expand Up @@ -214,9 +214,13 @@ Repo name to path mappings can be exact match (full name, full path) or wildcard

An exact match for the full repo name to a full path takes priority over a matching wildcard, and wildcard matches must match to a wildcard path.

An `:owner/:repo` template can be specified as a generic fallback. This replaces the deprecated
`default_path` configuration, which can be achieved using an `:owner/:repo` template that ignores
the `:owner` substitution.

```yaml
repoPaths:
default_path: ~/code/repos # fallback value if none of the other paths match
default_path: ~/code/repos # (deprecated) fallback parent directory if none of the other paths match
:owner/:repo: ~/src/github.com/:owner/:repo # template if you always clone github repos in a consistent location
dlvhdr/*: ~/code/repos/dlvhdr/* # will match dlvhdr/repo-name to ~/code/repos/dlvhdr/repo-name
dlvhdr/gh-dash: ~/code/gh-dash # will not match wildcard and map to specified path
Expand Down

0 comments on commit 6446f52

Please sign in to comment.