upstream/vagrant
1
0
Fork 0
mirror of https://github.com/hashicorp/vagrant.git synced 2026-05-28 04:36:05 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Suggest a more maintained plugin as an example

Browse source 
as vagrant-aws had no releases for >5 years
and seems to be completely unmaintained as of now
(see https://github.com/mitchellh/vagrant-aws/pull/570)
This commit is contained in:
Greg Dubicki 2021-12-26 13:36:59 +01:00 committed by GitHub
parent 0255034126
commit ceec45928c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
website/content/docs/plugins/packaging.mdx
View file

@ -24,10 +24,10 @@ comfortable with Ruby should approach.
The best way to describe packaging and distribution is to look at
how another plugin does it. The best example plugin available for this
is [vagrant-aws](https://github.com/mitchellh/vagrant-aws).
is [vagrant-google](https://github.com/mitchellh/vagrant-google).
By using [Bundler](http://bundler.io) and Rake, building a new
vagrant-aws package is easy. By simply calling `rake package`, a
vagrant-google package is easy. By simply calling `rake package`, a
`gem` file is dropped into the directory. By calling `rake release`,
the gem is built and it is uploaded to the central [RubyGems](https://rubygems.org)
repository so that it can be installed using `vagrant plugin install`.
@ -41,7 +41,7 @@ To setup your project, run `bundle gem vagrant-my-plugin`. This will create a
`vagrant-my-plugin` directory that has the initial layout to be a RubyGem.
You should modify the `vagrant-my-plugin.gemspec` file to add any
dependencies and change any metadata. View the [vagrant-aws.gemspec](https://github.com/mitchellh/vagrant-aws/blob/master/vagrant-aws.gemspec)
dependencies and change any metadata. View the [vagrant-google.gemspec](https://github.com/mitchellh/vagrant-google/blob/master/vagrant-google.gemspec)
for a good example.
~> **Do not depend on Vagrant** for your gem. Vagrant is no longer distributed
@ -89,7 +89,7 @@ If you run `rake -T` now, which lists all the available rake tasks,
you should see that you have the `package` and `release` tasks. You
can now develop your plugin and build it!
You can view the [vagrant-aws Rakefile](https://github.com/mitchellh/vagrant-aws/blob/master/Rakefile)
You can view the [vagrant-google Rakefile](https://github.com/mitchellh/vagrant-google/blob/master/Rakefile)
for a more comprehensive example that includes testing.
## Testing Your Plugin