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

Refactor "user config templates" to be in the main zmk repo #203

Open
3 tasks
petejohanson opened this issue Sep 23, 2020 · 1 comment
Open
3 tasks

Refactor "user config templates" to be in the main zmk repo #203

petejohanson opened this issue Sep 23, 2020 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers user configs

Comments

@petejohanson
Copy link
Contributor

Currently the setup.sh script (docs/static/setup.sh) uses separate git repos:

To clone the template, and then populate the initial user config repo being created by the script. This makes changing setup.sh harder, since it requires coordinate of PRs against multiple repos. It also means updates to the templates themselves are PRs against multiple repos, easier to miss some, etc.

We should refactor setup.sh to clone just a subdirectory of the main zmk repo, e.g. zmk/templates/split, zmk/templates/single, or zmk/templates/onboard, and use that to kickstart the user repo.

We'll need to leverage newer Git functionality for this, e.g.: https://stackoverflow.com/questions/600079/how-do-i-clone-a-subdirectory-only-of-a-git-repository/52269934#52269934

So we should also check the Git version before continuing.

ToDo:

  • Move template files into templates/* subdirectories.
  • Add git version check to setup.sh
  • Once ready to create the user repo, get the initial baseline files by cloning the appropriate subdirectory of the zmk repo.
@caksoylar
Copy link
Contributor

Related: #1178. I believe this would be addressed by #1183 as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers user configs
Projects
None yet
Development

No branches or pull requests

3 participants