Generate standard Chef directory structure with Knife command

Details

  • Type: New Feature New Feature
  • Status: Open Open
  • Priority: Unknown Unknown
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: Knife
  • Labels:

Description

The current way to get a canonical chef repository is to create it yourself (which is error prone) or clone it from opscode/chef-repo. There are two problems with cloning the chef-repo:

Cloning brings the git history along with it, bulking up the history of your repository in general.
You'll have to tweak your remotes to switch origin to upstream and create a new origin.
I built out the functionality as a knife task (knife repo create NAME) to automate the creation of the directory structure and standard files (readmes and Rakefile). You can pass -p /path/to/repo to create the repo in a different directory than the current one.

I didn't include any tests, since it is just building a directory and file structure without any dynamic elements. I mirrored how this was done from the knife cookbook create task.

The only thing I don't really like is keeping the text of the files in the methods themselves and I am more than open to suggestions for improving that.

https://github.com/opscode/chef/pull/322

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

Chris, please resolve the ticket as fixed when you provide a patch. This signals us that it is ready for review at our regular code review meetings. Thanks!

Show
Bryan McLellan [Opscode] added a comment - Chris, please resolve the ticket as fixed when you provide a patch. This signals us that it is ready for review at our regular code review meetings. Thanks!
Hide
Permalink
Chris Kelly added a comment -

Bryan, looks like the ticket's resolution is already set to "Fixed". Let me know if I am missing something.

The patch URL is:
https://github.com/opscode/chef/pull/322.patch

Show
Chris Kelly added a comment - Bryan, looks like the ticket's resolution is already set to "Fixed". Let me know if I am missing something. The patch URL is: https://github.com/opscode/chef/pull/322.patch
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

Sorry, I resolved it for you when I noted the step. We'll take a look at it during our code review meeting tomorrow. Thanks!

Show
Bryan McLellan [Opscode] added a comment - Sorry, I resolved it for you when I noted the step. We'll take a look at it during our code review meeting tomorrow. Thanks!
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

Chris, maintaining the documentation inlined with the code is an issue.

Also, what about just creating a directory and running 'git init' and being tied to git? It seems like this would be more useful for getting users started than the current step of cloning the git repo, but we're not sure there's a need to force them into having an SCM.

Show
Bryan McLellan [Opscode] added a comment - Chris, maintaining the documentation inlined with the code is an issue. Also, what about just creating a directory and running 'git init' and being tied to git? It seems like this would be more useful for getting users started than the current step of cloning the git repo, but we're not sure there's a need to force them into having an SCM.
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

Also, we're deprecating the rake tasks (CHEF-2353) so we should skip including the Rakefile so as to not lead anyone down a dead end.

Show
Bryan McLellan [Opscode] added a comment - Also, we're deprecating the rake tasks ( CHEF-2353 ) so we should skip including the Rakefile so as to not lead anyone down a dead end.
Hide
Permalink
Chris Kelly added a comment -

I definitely didn't like having the documentation inline. I think I'll put the documentation in separate files under chef/lib/chef/knife/repo_create/ where they can be source controlled independently.

The init_repo method catches the exception if they don't have git, but doesn't give them any other option. This could be made a command-line flag to select the SCM or none (with a default to git). I think encouraging SCM is a good practice, but also giving the user the option to change it should be in there.

Dropping the rake tasks out will be simple.

Let me know if the first two tweaks look to be inline with what you guys discussed.

Show
Chris Kelly added a comment - I definitely didn't like having the documentation inline. I think I'll put the documentation in separate files under chef/lib/chef/knife/repo_create/ where they can be source controlled independently. The init_repo method catches the exception if they don't have git, but doesn't give them any other option. This could be made a command-line flag to select the SCM or none (with a default to git). I think encouraging SCM is a good practice, but also giving the user the option to change it should be in there. Dropping the rake tasks out will be simple. Let me know if the first two tweaks look to be inline with what you guys discussed.
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

Re-resolving for review.

Show
Bryan McLellan [Opscode] added a comment - Re-resolving for review.
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

Moving the docs out to files is good.

Instead of running the git command, lets just end with something like.

"Now you should add this to your version control."
"If you use git, run 'git init #{repo_path}'"

Show
Bryan McLellan [Opscode] added a comment - Moving the docs out to files is good. Instead of running the git command, lets just end with something like. "Now you should add this to your version control." "If you use git, run 'git init #{repo_path}'"

People

  • Assignee:
    Unassigned
    Reporter:
    Chris Kelly
Vote (0)
Watch (0)

Dates

  • Created:
    Updated: