README.md in openstudio-extension-0.1.3 vs README.md in openstudio-extension-0.1.4

- old
+ new

@@ -105,10 +105,11 @@ │                └── extension │                          └── core └── spec +                ├── files                └── openstudio                          └── core @@ -137,19 +138,21 @@ In this new framework, each extension gem will contain one or more related measures. The gem will be the new 'home' of these measures, and the repo owner will be responsible for testing and keeping the measures up to date. In the short term, in order to preserve the PAT/OS App functionality, resource files will still be copied directly into the measures, and these measures will be pushed to BCL. ### Rake Tasks + Common Rake Tasks that are available to derivative extension gems include: + | Rake Task | Description | | --------- | ----------- | | openstudio:list_measures | List all measures in the calling gem | | openstudio:measures:add_license | Add License File to measures in the calling gem | | openstudio:measures:add_readme | Add README.md.erb file if it and the README markdown file do not already exist for a measure | | openstudio:measures:copy_resources | Copy the resources files to individual measures in the calling gem | | openstudio:measures:update_copyright | Update copyright on measure files in the calling gem | -| rake openstudio:runner:init | Create a runner.conf file running simulations | +| openstudio`:runner:`init | Create a runner.conf file running simulations | | openstudio:stage_bcl | Copy the measures to a location that can be uploaded to BCL | | openstudio:push_bcl | Upload measures from the specified location to the BCL | | openstudio:test_with_docker | Use openstudio docker image to run tests | | openstudio:test_with_openstudio | Use openstudio system ruby to run tests | | openstudio:update_measures | Run the CLI task to check for measure updates and update the measure xml files | @@ -221,13 +224,15 @@ $ gem install 'openstudio-extension' # Releasing the gem -* Update change log +* Update CHANGELOG.md +* Run `rake rubocop:auto_correct` * Update version in `/lib/openstudio/extension/version.rb` -* Merge down to master -* run `rake release` from master +* Create PR to master, after tests and reviews complete, then merge +* Locally - from the master branch, run `rake release` +* On GitHub, go to the releases page and update the latest release tag. Name it “Version x.y.z” and copy the CHANGELOG entry into the description box. # TODO - [X] Finalize documentation on naming conventions, etc - [X] Add test measure