metasploit-model 0.25.1 → 0.25.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzJiNmY5NWI5MTZjYzU3MWJjMTBhNTkwZDNkYTQ0YjA5MDkxZjEyMg==
+    MjBlNmMwY2U2ODY3ZWM1YzhmNzk3MzMxOWQ1M2E4ZmJjN2U0ZDk3MQ==
   data.tar.gz: !binary |-
-    OTM5Mzk1MGViYmZiYjVkN2JlMzFmZmJjMmQ1MTQ1ODE0ODVjZDQ0Zg==
+    YWE3YzlmMjBlNDk3YWVmNGFkZTM5YTgyOGQzNTU5ZTA2M2ZkOGE1NQ==
 SHA512:
   metadata.gz: !binary |-
-    MmNhYzU1ZDkwMGZkNjEwZGUyMDAyODlkZjhhN2U1NjNlNzI5MjY2YzExNWQ3
-    OGRjNWYyMTc5OTU1YzU4MjBlYTAzNTlhMmFhZjBjNGNlYzQxZjU3NjNiMjRj
-    NWNkYzA5MmQyNGJiYjhiZmU1YWRmMjRmNzliN2E0NjZkM2Q3YmY=
+    Y2IyNzMwMWFmOGQ3Y2UzNzhjMTNmYWVkNzU2OGRjOGJkY2Q1M2JjMTliYzU4
+    MmVhMmIwOGE0ZmU1NWMwMzUzZWM0NDZiZmNkYTIyYzg1NWQ4ZmIzOWI2NDIy
+    ZDU0MTg2NWVmNDNmMDZkOGQ0M2Q4ZWI1YjM0ODBlNTc5OWVjNDM=
   data.tar.gz: !binary |-
-    YTBhYzVjMTUwYTg4OWQyOTI0ZTg1OGZjMTg2M2RiYjNiYWRkODQwOTgzOGQ2
-    NmNhYzJiODhjOGYwZjQ3YTBlNzI1MTgxMmU3MThhOGZkODRlOTg1YzgyZWYz
-    ZmYzMWIwYTY0YTU5MGE2YmY3OGRlMTM1MWRhNjg2MTY4MTQ0YjU=
+    MGMxYTg1MTkwNTkzZDhmNzdlN2NkYWIyMDlhMTdhYzg5ZWJiNTlmMGY2MDlk
+    NjdiNmU1MGJmMzI4YTExMjU0NzRkZGZkNjRmMjQxYzkxOTFiMDAwYjQyMzEz
+    NDA0YmI3MjNmNzk1M2RlNDhkZWMyYWE0NmQxMzFlODZjNzE2ZGE=

data/CONTRIBUTING.md

@@ -0,0 +1,162 @@
+# Contributing
+
+## Forking
+
+[Fork this repository](https://github.com/rapid7/metasploit-model/fork)
+
+## Branching
+
+Branch names follow the format `TYPE/ISSUE/SUMMARY`.  You can create it with `git checkout -b TYPE/ISSUE/SUMMARY`.
+
+### `TYPE`
+
+`TYPE` can be `bug`, `chore`, or `feature`.
+
+### `ISSUE`
+
+`ISSUE` is either a [Github issue](https://github.com/rapid7/metasploit-model/issues) or an issue from some other
+issue tracking software.
+
+### `SUMMARY`
+
+`SUMMARY` is is short summary of the purpose of the branch composed of lower case words separated by '-' so that it is a valid `PRERELEASE` for the Gem version.
+
+## Changes
+
+### `PRERELEASE`
+
+1. Update `PRERELEASE` to match the `SUMMARY` in the branch name.  If you branched from `master`, and [version.rb](lib/metasploit/model/version.rb) does not have `PRERELEASE` defined, then adding the following lines after `PATCH`: 
+```
+# The prerelease version, scoped to the {PATCH} version number.
+PRERELEASE = '<SUMMARY>'
+```
+2. `rake spec`
+3.  Verify the specs pass, which indicates that `PRERELEASE` was updated correctly.
+4. Commit the change `git commit -a`
+
+
+### Your changes
+
+Make your changes or however many commits you like, commiting each with `git commit`.
+
+### Pre-Pull Request Testing
+
+1. Run specs one last time before opening the Pull Request: `rake spec`
+2. Verify there was no failures.
+
+### Push
+
+Push your branch to your fork on gitub: `git push push TYPE/ISSUE/SUMMARY`
+
+### Pull Request
+
+* [Create new Pull Request](https://github.com/rapid7/metasploit-model/compare/)
+* Add a Verification Steps comment
+
+```
+# Verification Steps
+
+- [ ] `bundle install`
+
+## `rake spec`
+- [ ] `rake spec`
+- [ ] VERIFY no failures
+```
+You should also include at least one scenario to manually check the changes outside of specs.
+
+* Add a Post-merge Steps comment
+
+The 'Post-merge Steps' are a reminder to the reviewer of the Pull Request of how to update the [`PRERELEASE`](lib/metasploit/model/version.rb) so that [version_spec.rb](spec/lib/metasploit/model/version_spec.rb) passes on the target branch after the merge.
+
+DESTINATION is the name of the destination branch into which the merge is being made.  SOURCE_SUMMARY is the SUMMARY from TYPE/ISSUE/SUMMARY branch name for the SOURCE branch that is being made.
+
+When merging to `master`:
+
+```
+# Post-merge Steps
+
+Perform these steps prior to pushing to master or the build will be broke on master.
+
+## Version
+- [ ] Edit `lib/metasploit/model/version.rb`
+- [ ] Remove `PRERELEASE` and its comment as `PRERELEASE` is not defined on master.
+
+## Gem build
+- [ ] gem build *.gemspec
+- [ ] VERIFY the gem has no '.pre' version suffix.
+
+## RSpec
+- [ ] `rake spec`
+- [ ] VERIFY version examples pass without failures
+
+## Commit & Push
+- [ ] `git commit -a`
+- [ ] `git push origin master`
+```
+
+When merging to DESTINATION other than `master`:
+
+```
+# Post-merge Steps
+
+Perform these steps prior to pushing to DESTINATION or the build will be broke on DESTINATION.
+
+## Version
+- [ ] Edit `lib/metasploit/model/version.rb`
+- [ ] Change `PRERELEASE` from `SOURCE_SUMMARY` to `DESTINATION_SUMMARY` to match the branch (DESTINATION) summary (DESTINATION_SUMMARY)
+
+## Gem build
+- [ ] gem build *.gemspec
+- [ ] VERIFY the prerelease suffix has change on the gem.
+
+## RSpec
+- [ ] `rake spec`
+- [ ] VERIFY version examples pass without failures
+
+## Commit & Push
+- [ ] `git commit -a`
+- [ ] `git push origin DESTINATION`
+```
+
+* Add a 'Release Steps' comment
+
+The 'Release Steps' are a reminder to the reviewer of the Pull Request of how to release the gem.
+
+```
+# Release
+
+Complete these steps on DESTINATION
+
+## Version
+
+### Compatible changes
+
+If the change are compatible with the previous branch's API, then increment [`PATCH`](lib/metasploit/model/version.rb).
+
+### Incompatible changes
+
+If your changes are incompatible with the previous branch's API, then increment
+[`MINOR`](lib/metasploit/model/version.rb) and reset [`PATCH`](lib/metasploit/model/version.rb) to `0`.
+
+- [ ] Following the rules for [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html), update
+[`MINOR`](lib/metasploit/model/version.rb) and [`PATCH`](lib/metasploit/model/version.rb) and commit the changes.
+
+## JRuby
+- [ ] `rvm use jruby@metasploit-model`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+
+## MRI Ruby
+- [ ] `rvm use ruby-1.9.3@metasploit-model`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+```
+
+### Downstream dependencies
+
+When releasing new versions, the following projects may need to be updated:
+
+* [metasploit_data_models](https://github.com/rapid7/metasploit_data_models)
+* [metasploit-credential](https://github.com/rapid7/metasploit-credential)

data/README.md

@@ -2,9 +2,7 @@
 
 ## Versioning
 
-`Metasploit::Model` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch
-should set `Metasploit::Model::Version::PRERELEASE` to the branch name, while master should have no `PRERELEASE`
-and the `PRERELEASE` section of `Metasploit::Model::VERSION` does not exist.
+`Metasploit::Model` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch should set `Metasploit::Model::Version::PRERELEASE` to the branch SUMMARY, while master should have no `PRERELEASE` and the `PRERELEASE` section of `Metasploit::Model::VERSION` does not exist.
 
 ## Installation
 
@@ -26,8 +24,4 @@ TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+See [CONTRIBUTING.md](CONTRIBUTING.md)

data/lib/metasploit/model/version.rb

@@ -7,7 +7,7 @@ module Metasploit
       # The minor version number, scoped to the {MAJOR} version number.
       MINOR = 25
       # The patch number, scoped to the {MINOR} version number.
-      PATCH = 1
+      PATCH = 2
 
       # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
       # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-model
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.25.2
 platform: ruby
 authors:
 - Luke Imhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,7 @@ files:
 - .simplecov
 - .travis.yml
 - .yardopts
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md