dlvhdr / gh-dash

A beautiful CLI dashboard for GitHub 🚀
https://dlvhdr.github.io/gh-dash
MIT License
6.82k stars 195 forks source link

Deprecate `default_path` support in `repoPaths` configuration #344

Closed rmacklin closed 4 months ago

rmacklin commented 4 months ago

Summary

Now that we support the more general :owner/:repo template configuration (https://github.com/dlvhdr/gh-dash/pull/343), the prior default_path functionality (https://github.com/dlvhdr/gh-dash/pull/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.

dlvhdr commented 4 months ago

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

rmacklin commented 4 months ago

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 commented 4 months ago

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

rmacklin commented 4 months ago

Ok sounds good! I've opened a new PR to remove default_path instead: https://github.com/dlvhdr/gh-dash/pull/345