Merge pull request #58 from urbanopt/develop

Prep 0.11.0

.github/release.yml

@@ -0,0 +1,26 @@
+# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options
+
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+      - DO NOT MERGE
+      - invalid
+      - dependencies
+      - tests
+    authors:
+      - octocat
+      - dependabot
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - Semver-Major
+        - breaking-change
+    - title: Exciting New Features 🎉
+      labels:
+        - Semver-Minor
+        - enhancement
+        - Feature
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/nightly_build.yml

@@ -1,11 +1,13 @@
-name: nightly_build
+name: Core-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: '25 5 * * 2-6'
+  pull_request:
+    types: [review_requested]
 
 env:
   # This env var should enforce develop branch of all dependencies
@@ -14,13 +16,11 @@ env:
 
 jobs:
   weeknight-tests:
-    # ubuntu-latest works since https://github.com/rbenv/ruby-build/releases/tag/v20220710 (July 10, 2022)
-    # 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

.gitignore

@@ -21,3 +21,6 @@ Gemfile.lock
 
 # Ignore IDE files
 /.idea
+
+# Mac OS X
+*.DS_Store

CHANGELOG.md

@@ -1,5 +1,18 @@
 # URBANopt Core Gem
 
+## Version 0.11.0
+
+## What's Changed
+### Exciting New Features 🎉
+* More tests by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/55
+* Os37 by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/56
+### Other Changes
+* remove Jenkinsfile by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/53
+* also run CI when a PR gets a review request by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/54
+
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-core-gem/compare/v0.10.0...v0.11.0
+
 ## Version 0.10.0
 Date Range: 12/12/22 - 07/19/23
 

CONTRIBUTING.md

@@ -8,15 +8,15 @@ The contribution process for URBANopt is composed of three steps:
 
 ## 1. Send consent email
 
-In order for us to distribute your code as part of URBANopt under the URBANopt SDK [license](https://github.com/urbanopt/urbanopt-scenario-gem/blob/develop/LICENSE.md), we’ll need your consent. An email acknowledging your understanding of these terms and agreeing to them is all that will be asked of any contributor. Send an email to the URBANopt project manager ([see below](#documentation) for the address) including the following text and a list of co-contributors (if any):
+In order for us to distribute your code as part of URBANopt under the URBANopt SDK [license](https://github.com/urbanopt/urbanopt-core-gem/blob/develop/LICENSE.md), we’ll need your consent. An email acknowledging your understanding of these terms and agreeing to them is all that will be asked of any contributor. Send an email to the URBANopt project manager ([see below](#documentation) for the address) including the following text and a list of co-contributors (if any):
 
 *I agree to contribute to the URBANopt SDK. I agree to the following terms and conditions for my contributions: First, I agree that I am licensing the copyright to my contributions under the terms of the current URBANopt SDK license. Second, I hereby grant to Alliance for Sustainable Energy, LLC, to any successor manager and distributor of URBANopt SDK appointed by the U.S. Department of Energy, and to all recipients of a version of URBANopt SDK that includes my contributions, a non-exclusive, worldwide, royalty-free, irrevocable patent license under any patent claims owned by me, or owned by my employer and known to me, that are or will be,necessarily infringed upon by my contributions alone, or by combination of my contributions with the version of URBANopt SDK to which they are contributed, to make, have made, use, offer to sell, sell, import, and otherwise transfer any version of URBANopt SDK that includes my contributions, in source code and object code form. Third, I represent and warrant that I am authorized to make the contributions and grant the foregoing license(s). Additionally, if, to my knowledge, my employer has rights to intellectual property that covers my contributions, I represent and warrant that I have received permission to make these contributions and grant the foregoing license(s) on behalf of my employer.*
 
 Once we have your consent on file, you’ll only need to redo it if conditions change (e.g. a change of employer).
 
 ## 2. Scope agreement and timeline commitment
 
-If your contribution is small (e.g. a bug fix), simply submit your contribution via GitHub. If you find a bug, first make sure it is not an already known issue, then report it in the GitHub [issue tracker](https://github.com/urbanopt/urbanopt-scenario-gem/issues) for this repository. If your contribution is larger (e.g. a new feature or new functionality/capability), we’ll need to evaluate your proposed contribution first. We may ask you to revise your materials and make changes to it, which we will then re-review.
+If your contribution is small (e.g. a bug fix), simply submit your contribution via GitHub. If you find a bug, first make sure it is not an already known issue, then report it in the GitHub [issue tracker](https://github.com/urbanopt/urbanopt-core-gem/issues) for this repository. If your contribution is larger (e.g. a new feature or new functionality/capability), we’ll need to evaluate your proposed contribution first. We may ask you to revise your materials and make changes to it, which we will then re-review.
 
 ## 3. Technical contribution process
 

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/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,

lib/measures/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - 'spec/test_measures/**/*'
+require: rubocop-performance
+inherit_from:
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml

lib/urbanopt/core/version.rb

@@ -5,6 +5,6 @@
 
 module URBANopt
   module Core
-    VERSION = '0.10.0'.freeze
+    VERSION = '0.11.0'.freeze
   end
 end

spec/urbanopt/urbanopt_core_spec.rb

@@ -9,4 +9,9 @@
   it 'has a version number' do
     expect(URBANopt::Core::VERSION).not_to be nil
   end
+
+  it 'has a measures directory' do
+    instance = URBANopt::Core::Extension.new
+    expect(File.exist?(Pathname(instance.measures_dir))).to be true
+  end
 end

urbanopt-core-gem.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.18.2'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
 
-  spec.add_dependency 'openstudio-extension', '~> 0.6.1'
+  spec.add_dependency 'openstudio-extension', '~> 0.7.1'
 end