bcl-gem's Introduction

BCL Gem

All the methods to build, test, and release the gem available as rake tasks via bundler/gem_tasks. Note that you can see all the rake tasks by calling rake -T at the command line.

Building BCL Gem

If this is a new version that will be release first edit the ./lib/bcl/version.rb file and increment the version number. This will automatically propagate through the build process.

rake build

To install:

rake install

Releasing Gem

Note: Releasing the gem will call the build command, tag it in Git, and push to rubygems.

run rake release

Testing

rake spec

Uninstall

run gem uninstall bcl -a

Workflow for pushing content to BCL

run rake bcl:stage_and_upload[/path/to/content, resetFlag]

where path/to/content is a path to the directory of measures or components to upload and resetFlag is a boolean flag indicating whether to clear already staged content and receipt files (true), or to keep the staged content and receipt files (false).

Staging and Uploading tasks can be called separately:

rake bcl:stage_content[/path/to/content, resetFlag]

rake bcl:upload_content[resetFlag]

bcl-gem's People

Contributors

Stargazers

Watchers

bcl-gem's Issues

Remove dependencies on native gems

Document new BCL workflow and improve docs

Tutorial for uploading/updating and publishing with group roles and screenshots
How to use the gem/rakefile functionality
Can only get latest version of a measure or component
Better API documentation for all API resources
Measure schema: https://bcl.nrel.gov/xsd/measure/v/3
BCL Group roles and where to set them

*editor role: can put measure draft in ‘needs review’ state first.  then can put in ‘published’ state

*administrator member role: can go from draft to published in one step

*no group role: can put measure draft in ‘needs review’ state. An editor or admin member will have to publish the measure

Add item to BCL tutorial for groups to add their contact info in their group description so that users can contact them if there are issues with their content