Merge pull request #270 from urbanopt/develop

Prep v0.11.0

.github/workflows/nightly_ci_build.yml

@@ -1,12 +1,14 @@
 
-name: nightly_build
+name: Scenario-gem CI
 
 on:
   # push:
   schedule:
     # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
     # 5 am UTC (11pm MDT the day before) every weekday night in MDT
     - cron: '21 5 * * 2-6'
+  pull_request:
+    types: [review_requested]
 
 env:
   # This env var should enforce develop branch of all dependencies
@@ -19,9 +21,9 @@ jobs:
     # https://github.com/rbenv/ruby-build/discussions/1940
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.6.1
+      image: docker://nrel/openstudio:3.7.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Update gems
         run: bundle update
       - name: Run Rspec

CHANGELOG.md

@@ -1,5 +1,16 @@
 # URBANopt Scenario Gem
 
+## Version 0.11.0
+Date Range: 07/06/23 - 01/10/24
+
+* Add transformer in- and out-going voltages to reporting by @vtnate in https://github.com/urbanopt/urbanopt-scenario-gem/pull/265
+* Remove jenkins by @vtnate in https://github.com/urbanopt/urbanopt-scenario-gem/pull/264
+* also run CI when a PR gets a review request by @vtnate in https://github.com/urbanopt/urbanopt-scenario-gem/pull/266
+* enforce using sqlite3 v1.6 because 1.7 requires ruby3 by @vtnate in https://github.com/urbanopt/urbanopt-scenario-gem/pull/269
+* Support os37 for testing by @vtnate in https://github.com/urbanopt/urbanopt-scenario-gem/pull/267
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-scenario-gem/compare/v0.10.0...v0.11.0
+
 ## Version 0.10.0
 Date Range: 12/5/22 - 7/6/23
 

Gemfile

@@ -23,7 +23,7 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../urbanopt-core-gem')
 #  gem 'urbanopt-core', path: '../urbanopt-core-gem'
 # elsif allow_local
-# gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
+# gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'os37'
 # end
 
 # if allow_local && File.exist?('../openstudio-common-measures-gem')
@@ -39,9 +39,9 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # end
 
 # if allow_local && File.exist?('../urbanopt-reporting-gem')
-#  gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
+# gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
 # elsif allow_local
-# gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
+# gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'dependency-patch'
 # end
 
 # if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')

LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

README.md

@@ -1,7 +1,7 @@
 # URBANopt Scenario Gem
 
 [![Coverage Status](https://coveralls.io/repos/github/urbanopt/urbanopt-scenario-gem/badge.svg?branch=develop)](https://coveralls.io/github/urbanopt/urbanopt-scenario-gem?branch=develop)
-[![nightly_build](https://github.com/urbanopt/urbanopt-scenario-gem/actions/workflows/nightly_build.yml/badge.svg)](https://github.com/urbanopt/urbanopt-scenario-gem/actions/workflows/nightly_build.yml)
+[![nightly_build](https://github.com/urbanopt/urbanopt-scenario-gem/actions/workflows/nightly_ci_build.yml/badge.svg)](https://github.com/urbanopt/urbanopt-scenario-gem/actions/workflows/nightly_ci_build.yml)
 
 The URBANopt™ Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. The ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
 
@@ -34,9 +34,12 @@ Check out the repository and then execute:
 
 ## Releasing
 
-* Update CHANGELOG.md
 * Run `rake rubocop:auto_correct`
 * Update version in `/lib/urbanopt/scenario/version.rb`
+* On GitHub, go to the releases page and update the latest release tag (from develop). Name it “Version x.y.z”, set the previous tag to the appropriate value, and click the `Generate release notes` button
+    * Copy the text generated, which is sorted according to PR labels
+    * Discard the release or save as draft
+* Update CHANGELOG.md appropriately, with dates and the content copied from GitHub
 * Create PR to master, after tests and reviews complete, then merge
+* In GitHub, make a new release or complete the previous one, basing off master/main
 * 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.

Rakefile

@@ -1,43 +1,8 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
-# contributors. All rights reserved.
-
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-
-# Redistributions of source code must retain the above copyright notice, this list
-# of conditions and the following disclaimer.
-
-# Redistributions in binary form must reproduce the above copyright notice, this
-# list of conditions and the following disclaimer in the documentation and/or other
-# materials provided with the distribution.
-
-# Neither the name of the copyright holder nor the names of its contributors may be
-# used to endorse or promote products derived from this software without specific
-# prior written permission.
-
-# Redistribution of this software, without modification, must refer to the software
-# by the same designation. Redistribution of a modified version of this software
-# (i) may not refer to the modified version by the same designation, or by any
-# confusingly similar designation, and (ii) must refer to the underlying software
-# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
-# the term “URBANopt”, or any confusingly similar designation may not be used to
-# refer to any modified version of this software or any modified version of the
-# underlying software originally provided by Alliance without the prior written
-# consent of Alliance.
-
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-scenario-gem/blob/develop/LICENSE.md
 # *********************************************************************************
-#
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *********************************************************************************
-  # URBANopt (tm), Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
   # contributors. All rights reserved.
 
   # Redistribution and use in source and binary forms, with or without modification,