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

Deprecate default_path support in repoPaths configuration #344

Conversation

rmacklin
Copy link
Contributor

@rmacklin rmacklin commented Mar 4, 2024

Summary

Now that we support the more general :owner/:repo template configuration (#343), the prior default_path functionality (#327) is redundant - e.g. this configuration:

default_path: ~/code/repos

can be achieved equivalently 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.

How did you test this change?

This is just a documentation change.

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.
@dlvhdr
Copy link
Owner

dlvhdr commented Mar 6, 2024

Might be worth running a quick code search to see how many use this. Something like: path:gh-dash/config.yml default_path

@rmacklin
Copy link
Contributor Author

rmacklin commented Mar 6, 2024

There are 2 results (and one commented-out value) for that query:
https://github.com/search?q=path%3Agh-dash%2Fconfig.yml%20default_path&type=code

That said, I'm not sure how representative this is, given that many folks might not push their dash config to a public GItHub repo.

@dlvhdr
Copy link
Owner

dlvhdr commented Mar 6, 2024

Ok cool, then given this not very scientific way, lets remove the default path entirely 😀

@rmacklin
Copy link
Contributor Author

rmacklin commented Mar 7, 2024

Ok sounds good! I've opened a new PR to remove default_path instead: #345

@rmacklin rmacklin closed this Mar 7, 2024
@rmacklin rmacklin deleted the deprecate-default_path-support-in-repoPaths-configuration branch March 7, 2024 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants