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

Rake task to help frame a plugin #12

Open
mbbroberg opened this issue Jan 30, 2018 · 4 comments
Open

Rake task to help frame a plugin #12

mbbroberg opened this issue Jan 30, 2018 · 4 comments

Comments

@mbbroberg
Copy link
Contributor

After someone forks this repository, it would be very helpful to have a simple rake task that ensures that the user can quickly frame out a new plugin simply by running something like rake new sendgrid and it creates ../sensu-plugins-sendgrid plugin framed out.

I'd like to keep discussing the exactly syntax and then ask for some help from others to complete it. cc @majormoses

@majormoses
Copy link
Member

I see a couple of steps that would make life easier creating plugins and I believe they could be solved with a couple relatively straightforward tasks:

  • copy repo, includes all dotfiles except .git (exact match as we have .github which should be copied. Other exception I can think of is README-skel.md
  • rename and replace all occurrences of skel, Skel, etc to the appropriate values
  • copy a template changelog to make it clear that the changelog starts fresh when copied rather than the changelog of the skel itself
  • create issue for maintainer to add labels and invite user to maintain the repo
  • create issue for maintainer to add rubygems/travis setup

@lagartoflojo
Copy link
Contributor

Another question is how to keep already-created plugins up to date with the skeleton :)

@majormoses
Copy link
Member

Another question is how to keep already-created plugins up to date with the skeleton :)

Ya thats a difficult thing to do I have mostly been either updating things as I see them or automating search/replacement and creating pull requests.

@majormoses
Copy link
Member

One thing we could do is make the skel a collection of erb templates which would I think make it easier. Wow been a while since I have looked at this.

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

No branches or pull requests

3 participants