Release 2.16 (#3651)

Author: nllong

.github/release.yml

@@ -0,0 +1,37 @@
+# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options
+
+changelog:
+  exclude:
+    labels:
+      - DO NOT MERGE
+      - dependencies
+      - Verify No Longer Relevant
+      - No Longer Valid
+      - Not Reproducible
+      - Duplicate
+      - To Investigate
+      - Ignore in release notes
+    authors:
+      - octocat
+      - dependabot
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - Semver-Major
+        - breaking-change
+    - title: New Features 🎉
+      labels:
+        - Semver-Minor
+        - Enhancement
+        - Feature
+    - title: Maintenance
+      labels:
+        - Maintenance
+        - Documentation
+        - Performance
+    - title: Bug Fixes
+      labels:
+        - Bug
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/stale.yml

@@ -13,5 +13,5 @@ jobs:
         with:
           stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions."
           close-issue-message: "This issue has been closed automatically. If this still affects you please re-open this issue with a comment or contact us so we can look into resolving it."
-          exempt-issue-labels: "P-1,P-2,Impact-1,Milestone"
+          exempt-all-milestones: true
           operations-per-run: 500

.gitignore

@@ -9,7 +9,6 @@
 .coverage
 .vscode
 coverage.protractor.json
-.noseids
 .vscode
 *~
 *~$*

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ exclude: |
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.3.0
     hooks:
       - id: trailing-whitespace
       - id: check-added-large-files
@@ -31,8 +31,8 @@ repos:
             --skip=seed/models/__init__.py,
             --filter-files,
           ]
-  - repo: https://github.com/humitos/mirrors-autoflake.git
-    rev: v1.1
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.0.0
     hooks:
       - id: autoflake
         args:
@@ -42,13 +42,13 @@ repos:
             "--remove-all-unused-imports",
             "--remove-unused-variable",
           ]
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.2
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
     hooks:
       - id: flake8
         args: ["--ignore=F401,E402,E501,E731,W503,W504"]
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.6.2
+    rev: v2.7.1
     hooks:
       - id: prettier
         # for now ignoring html, javascript

CHANGELOG.md

@@ -1,40 +1,63 @@
-# SEED Version 2.16.0-beta
-
-This Beta released contains new functionality to help track building-portfolio programs such as Benchmarking and basic-Building Performance Standards. In order to track programs, SEED was updated with a program configuration page with the selection of two metrics to track (typically an energy and emissions metric). The tracking requires an actual and a goal column to be defined allowing the program to determine if a property is in compliance.
-
-A new program insight page was creating allowing easy visualization over the compliance periods. In addition, new backend functionality was created for "filter groups" allowing for a user to save a set of labels and filters into a recallable filter group. The filter groups can be then aggregated with sums, averages, etc., and plotted on a custom report page.
-
-Date Range: 09/08/22 - 09/29/22
-
-Closed Issues and Features (Total: 28):
-- Fixed [#3148]( https://github.com/SEED-platform/seed/issues/3148 ), Beta Property List view: Tax lot data is not being displayed under Properties, and Properties are not being displayed under Tax Lots
-- Fixed [#3341]( https://github.com/SEED-platform/seed/issues/3341 ), Replace charting library on reports page
-- Feature [#3346]( https://github.com/SEED-platform/seed/issues/3346 ), Filter Group - Back End
-- Feature [#3349]( https://github.com/SEED-platform/seed/issues/3349 ), Filter Group - Front End (Inventory List)
-- Feature [#3354]( https://github.com/SEED-platform/seed/issues/3354 ), Enable ability to not map a column in SEED
-- Fixed [#3433]( https://github.com/SEED-platform/seed/issues/3433 ), Add translations to BETTER Analysis helper text
-- Feature [#3459]( https://github.com/SEED-platform/seed/issues/3459 ), Create Compliance Metric Setup Page
-- Feature [#3460]( https://github.com/SEED-platform/seed/issues/3460 ), Create Program Overview Page
-- Feature [#3467]( https://github.com/SEED-platform/seed/issues/3467 ), integrate filter_groups into data_view
-- Feature [#3487]( https://github.com/SEED-platform/seed/issues/3487 ), Create Property Insights Page
-- Fixed [#3489]( https://github.com/SEED-platform/seed/issues/3489 ), Phrase 'Data View' to 'Custom Reports'
-- Fixed [#3491]( https://github.com/SEED-platform/seed/issues/3491 ), Confirm edit and save updates the graph
-- Fixed [#3493]( https://github.com/SEED-platform/seed/issues/3493 ), Improve DataView Plot legend and format table
-- Fixed [#3494]( https://github.com/SEED-platform/seed/issues/3494 ), Refresh list of dataviews when on metrics overview page
-- Fixed [#3524]( https://github.com/SEED-platform/seed/issues/3524 ), Create function for selecting 'No Filter Group'
-- Fixed [#3525]( https://github.com/SEED-platform/seed/issues/3525 ), Update the link for Program Overview on Program Setup Page
-- Fixed [#3527]( https://github.com/SEED-platform/seed/issues/3527 ), Lokalize check all strings
-- Fixed [#3528]( https://github.com/SEED-platform/seed/issues/3528 ), Create UI indicator when saving changes on Program Metric Configuration Page
-- Fixed [#3529]( https://github.com/SEED-platform/seed/issues/3529 ), Modify "Save Changes" button on Program Setup Page
-- Fixed [#3531]( https://github.com/SEED-platform/seed/issues/3531 ), Amend "Year Built" axis on Property Insights Page
-- Fixed [#3532]( https://github.com/SEED-platform/seed/issues/3532 ), Remove gaps between nav links
-- Fixed [#3533]( https://github.com/SEED-platform/seed/issues/3533 ), Update Program Setup page for an additional metric type check
-- Fixed [#3534]( https://github.com/SEED-platform/seed/issues/3534 ), Integrate auto-refresh to the Custom Reports Page
-- Fixed [#3535]( https://github.com/SEED-platform/seed/issues/3535 ), Update Program Setup page for a check on actual column
-- Fixed [#3536]( https://github.com/SEED-platform/seed/issues/3536 ), Fix the auto-populate modal which shows empty scrollbars by default
-- Fixed [#3537]( https://github.com/SEED-platform/seed/issues/3537 ), Fix the docker images that don't support the TZ environment variable without adding tzdata via apk
-- Fixed [#3538]( https://github.com/SEED-platform/seed/issues/3538 ), Fix the temporary underline that results from :focus not being handled
-- Fixed [#3558]( https://github.com/SEED-platform/seed/issues/3558 ), Program Setup: Add 'string' data type to valid column data types
+# SEED Version 2.16.0
+
+This release contains new functionality to help track building-portfolio programs such as Benchmarking and basic-Building Performance Standards. In order to track programs, SEED was updated with a program configuration page with the selection of two metrics to track (an energy and emissions metric). The tracking requires an actual and a goal column to be defined allowing the program to determine if a property is in compliance.
+
+A new program insight page was created to allow easy visualization over the compliance periods. In addition, new backend functionality was created for "filter groups" allowing for a user to save a set of labels and filters into a recallable filter group. The filter groups can be then aggregated with sums, averages, etc., and plotted on a custom report page.
+
+Lastly, the new changelog format comes directly from GitHub now, removing the need to run the custom GitHub script.
+<!-- Release notes generated using configuration in .github/release.yml at 2.16.0-release-prep -->
+
+## What's Changed
+### New Features 🎉
+* Add filter groups to insight page by @haneslinger in https://github.com/SEED-platform/seed/pull/3505
+* Add GHG and GHG Intensity units by @Ryoken in https://github.com/SEED-platform/seed/pull/3518
+* Data insight view format and usability improvements by @aviveiros11 in https://github.com/SEED-platform/seed/pull/3519
+* Enable ability to not map a column in SEED by @haneslinger in https://github.com/SEED-platform/seed/pull/3523
+* Program metric and insights pages by @kflemin in https://github.com/SEED-platform/seed/pull/3521
+* BPS insights development by @haneslinger in https://github.com/SEED-platform/seed/pull/3546
+* Program metric UI improvements by @aviveiros11 in https://github.com/SEED-platform/seed/pull/3542
+* Implement Program Setup Page by @anchapin in https://github.com/SEED-platform/seed/pull/3541
+* Add simple export buttons to charts by @haneslinger in https://github.com/SEED-platform/seed/pull/3561
+* Switch to created filter group after creation by @haneslinger in https://github.com/SEED-platform/seed/pull/3569
+* Use the same color for each axis per filter group by @haneslinger in https://github.com/SEED-platform/seed/pull/3587
+* Add 'ghg' and 'ghg_intensity' to 'valid_column_data_types' for Custom Report by @anchapin in https://github.com/SEED-platform/seed/pull/3570
+* Add export column mappings by @nllong in https://github.com/SEED-platform/seed/pull/3611
+* Allow filtering on all columns including related taxlots/properties by @haneslinger in https://github.com/SEED-platform/seed/pull/3618
+* Add the ability to create multiple compliance programs by @anchapin in https://github.com/SEED-platform/seed/pull/3623
+* Add create, update, retrieve, and delete to Meter API by @nllong in https://github.com/SEED-platform/seed/pull/3639
+### Maintenance
+* Update report charts to use Charts.js by @kflemin in https://github.com/SEED-platform/seed/pull/3368
+* Add translations to BETTER Analysis helper text by @anchapin in https://github.com/SEED-platform/seed/pull/3562
+* Add missing Lokalize tags by @aviveiros11 in https://github.com/SEED-platform/seed/pull/3563
+* Fix Typos by @axelstudios in https://github.com/SEED-platform/seed/pull/3564
+* Output proper error message by @haneslinger in https://github.com/SEED-platform/seed/pull/3592
+* Final version of the BPS sample data files by @anchapin in https://github.com/SEED-platform/seed/pull/3584
+* Remove nosetests and fix precommit by @nllong in https://github.com/SEED-platform/seed/pull/3619
+* BPS Data Final Updates by @anchapin in https://github.com/SEED-platform/seed/pull/3646
+### Bug Fixes
+* Fix only collect columns that aren't related by @Ryoken in https://github.com/SEED-platform/seed/pull/3515
+* Revised the Custom Reports page to remove custom report from list after deletion by @anchapin in https://github.com/SEED-platform/seed/pull/3522
+* Fix null x axis by @kflemin in https://github.com/SEED-platform/seed/pull/3543
+* Fix SEED logo focus by @axelstudios in https://github.com/SEED-platform/seed/pull/3547
+* Fix auto-populate scrollbars by @axelstudios in https://github.com/SEED-platform/seed/pull/3549
+* Fix navigation gaps by @axelstudios in https://github.com/SEED-platform/seed/pull/3550
+* Add tzdata dependency to docker images by @axelstudios in https://github.com/SEED-platform/seed/pull/3548
+* Add 'string' data type to valid column data types in Program Setup by @anchapin in https://github.com/SEED-platform/seed/pull/3560
+* Force utility spinner and refresh to update chart by @aviveiros11 in https://github.com/SEED-platform/seed/pull/3540
+* Add error check for blank Actual Column in Program Setup by @anchapin in https://github.com/SEED-platform/seed/pull/3572
+* Use the same column for the names used in Property Insights by @anchapin in https://github.com/SEED-platform/seed/pull/3578
+* On FilterGroup delete, filter groups don't filter≈y by @haneslinger in https://github.com/SEED-platform/seed/pull/3596
+* Update inventory reporting charts by @nllong in https://github.com/SEED-platform/seed/pull/3604
+* Fix update labels and label selected by @haneslinger in https://github.com/SEED-platform/seed/pull/3615
+* Fix ESPM get template with no children by @haneslinger in https://github.com/SEED-platform/seed/pull/3632
+* Fix note's API result to not include related model's view ID by @nllong in https://github.com/SEED-platform/seed/pull/3635
+* Apply label to only selected by @haneslinger in https://github.com/SEED-platform/seed/pull/3637
+* Update alt text, remove metric from program by @nllong in https://github.com/SEED-platform/seed/pull/3647
+### Other Changes
+* Remove use of campus on the property model by @nllong in https://github.com/SEED-platform/seed/pull/3614
+* Fix permissions for viewers to see program overview by @haneslinger in https://github.com/SEED-platform/seed/pull/3620
+
+**Full Changelog**: https://github.com/SEED-platform/seed/compare/v2.15.2...v2.16.0
 
 # SEED Version 2.15.2
 

config/settings/common.py

@@ -234,12 +234,6 @@
 PASSWORD_RESET_EMAIL = SERVER_EMAIL
 DEFAULT_FROM_EMAIL = SERVER_EMAIL
 
-# Added By Gavin on 1/27/2014
-TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
-NOSE_PLUGINS = [
-    'nose_exclude.NoseExclude',
-]
-
 AUTH_USER_MODEL = 'landing.SEEDUser'
 AUTH_PASSWORD_VALIDATORS = [
     {

config/settings/docker_dev.py

@@ -60,18 +60,6 @@
 }
 
 if SEED_TESTING:
-    INSTALLED_APPS += (  # noqa F405
-        "django_nose",
-    )
-    TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
-    NOSE_PLUGINS = [
-        'nose_exclude.NoseExclude',
-    ]
-    NOSE_ARGS = [
-        '--nocapture',
-        # '--nologcapture',
-    ]
-
     CELERY_BROKER_BACKEND = 'memory'
     CELERY_TASK_ALWAYS_EAGER = True
     CELERY_TASK_EAGER_PROPAGATES = True

config/settings/test.py

@@ -39,19 +39,6 @@
 # this celery log level is currently not overridden.
 CELERY_LOG_LEVEL = LOG_LEVELS['WARNING']
 
-# Testing
-INSTALLED_APPS += ( # noqa F405
-    "django_nose",
-)
-TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
-NOSE_PLUGINS = [
-    'nose_exclude.NoseExclude',
-]
-NOSE_ARGS = [
-    '--nocapture',
-    '--nologcapture',
-]
-
 REQUIRE_UNIQUE_EMAIL = False
 
 INTERNAL_IPS = ('127.0.0.1',)

docs/source/developer_resources.rst

@@ -432,18 +432,15 @@ Release Instructions
 
 To make a release do the following:
 
+1. Create a branch to prepare the updates (e.g., 2.16.0-release-prep).
 1. Github admin user, on develop branch: update the ``package.json`` and ``npm-shrinkwrap.json`` files with the most recent version number. Always use MAJOR.MINOR.RELEASE.
-2. Update the ``docs/sources/migrations.rst`` file with any required actions.
-3. Run the ``docs/scripts/change_log.py`` script and add the changes to the CHANGELOG.md file for the range of time between last release and this release. Only add the *Closed Issues*. Also make sure that all the pull requests have a related Issue in order to be included in the change log.
-
-.. code-block:: console
-
-    python docs/scripts/change_log.py –k GITHUB_API_TOKEN –s 2022-03-31 –e 2022-05-29
-
-4. Paste the results (remove unneeded Accepted Pull Requests and the new issues) into the CHANGELOG.md. Cleanup the formatting (if needed).
-5. Make sure that any new UI needing localization has been tagged for translation, and that any new translation keys exist in the lokalise.com project. (see :doc:`translation documentation <translation>`).
-6. Once develop passes, then create a new PR from develop to main.
-7. Draft new Release from Github (https://github.com/SEED-platform/seed/releases).
-8. Include list of changes since previous release (i.e., the content in the CHANGELOG.md)
-9. Verify that the Docker versions are built and pushed to Docker hub (https://hub.docker.com/r/seedplatform/seed/tags/).
-10. Publish the new documentation in the seed-platform website repository (see instructions above under Building Documentation).
+1. Update the ``docs/sources/migrations.rst`` file with any required actions.
+1. Push updates to new branch on GitHub, then go to the releases page to draft a new release which will generate the changelog.
+1. Copy the GitHub change log results into the CHANGELOG.md. Cleanup the formatting and items as needed (make sure the spelling is correct, starts with a capital letter, etc.)
+1. Make sure that any new UI needing localization has been tagged for translation, and that any new translation keys exist in the lokalise.com project. (see :doc:`translation documentation <translation>`).
+1. Create PR for release preparation and merge after tests/reviews pass.
+1. Once develop tests pass, then create a new PR from develop to main.
+1. Draft new Release from Github (https://github.com/SEED-platform/seed/releases).
+1. Include list of changes since previous release (i.e., the content in the CHANGELOG.md)
+1. Verify that the Docker versions are built and pushed to Docker hub (https://hub.docker.com/r/seedplatform/seed/tags/).
+1. Publish the new documentation in the seed-platform website repository (see instructions above under Building Documentation).

docs/source/migrations.rst

@@ -46,9 +46,10 @@ local_untracked.py file
             routing_key=CELERY_TASK_DEFAULT_QUEUE
         ),
     )
-Version 2.16.0-beta
+Version 2.16.0
 -----------------------
 - There are no special migrations needed for this version. Simply run `./manage.py migrate`.
+
 Version 2.15.2
 -----------------------
 - There are no migrations needed for this version.