Merge branch 'dev' of https://github.com/Green-Software-Foundation/ca…

…rbon-aware-sdk into romanlutz/fix_typos

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to the Carbon Aware SDK will be documented in this file.
 
-## [Unreleased]
+## [1.1.0] - 2023-18-07
 
 ### Added 
 
@@ -12,26 +12,75 @@ All notable changes to the Carbon Aware SDK will be documented in this file.
 ### Fixed
 
 - Fixed generated test data that had time bomb bug that was in test data, which caused integration tests to fail.  This is now automatically generated each time.
+- Fixed some bugs that related to underlying data source errors surfacing as HTTP 500 errors from the API.  These should now be more consistent.
+- Fixed an issue where UTF-8 passwords were encoded as ASCII for WattTime API, causing integration failure. 
+- Fixes some bugs in unit tests with uncaught scenarios, or faulty tests.
 
 ### Changed
 
+- No previous API's were changed.  
+- Configuration has changed.  Refer to upgrading from 1.0.0 to 1.1.0 below.
+- Time is now always in UTC.  Previously the API may have returned local time depending on underlying API.
+
 #### API
 
 - `/locations` - Show the list of configured named locations that can be used in the API.
-- `/api/v1/swagger.yaml` - Provide OpenAPI document.
+- `/api/v1/swagger.yaml` - Provides OpenAPI document now at public endpoint when deployed.
 
 #### API Deployment
 
 - Configuration has changed.  Refer to upgrading from 1.0.0 to 1.1.0 below.
 
 #### SDK 
 
-- Funcationality for forecast and historical data have been seperated into seperate interfaces.  This impacts configuration, see upgrading from 1.0.0 to 1.1.0 for more information
-- Additional tests
+- SDK was abstracted to provide a library for DLL import usage, which now allows users to use the SDK in their projects directly without the need to deploy an API.  This is useful in scenarios where the API can not be centralised.  Note - we still highly recommend centralising for management of the API and audit capabilities with observability.
+- Functionality for forecast and historical data have been seperated into seperate interfaces.  This impacts configuration, see upgrading from 1.0.0 to 1.1.0 for more information.
+- Additional tests across the SDK have been added.
+- Aggregation tier in the SDK was removed, this should not impact users of the SDK, but may impact maintainers who were actively contributing.
+
+
+#### Other
+
+- All contributors need to signoff commits for contribution using `git commit -s`.
+- Added PR release workflow improvements for the project management of the CA SDK project team.
+- Updated the project to prune stale PR's and issues to help with the management of the CA SDK project.
+
 
 ### Upgrading from 1.0.0 to 1.1.0 
 
-- Configuration changes are required due to historical and forecast configuration now being decoupled.  Refer to ___ for a guide.
+- Configuration changes are required due to historical and forecast configuration now being decoupled.  Refer to - [Configuration](docs/configuration.md) for a guide. The following is provided as an example of the new data source configuration format.
+```json
+{
+  "DataSources": {
+    "EmissionsDataSource": "Json",
+    "ForecastDataSource": "WattTime",
+    "Configurations": {
+      "WattTime": {
+        "Type": "WattTime",
+        "Username": "username",
+        "Password": "password",
+        "BaseURL": "https://api2.watttime.org/v2/",
+        "Proxy": {
+          "useProxy": true,
+          "url": "http://10.10.10.1",
+          "username": "proxyUsername",
+          "password": "proxyPassword"
+        }
+      },
+      "ElectricityMaps": {
+        "Type": "ElectricityMaps",
+        "APITokenHeader": "auth-token",
+        "APIToken": "myAwesomeToken",
+        "BaseURL": "https://api.electricitymap.org/v3/"
+      },
+      "Json": {
+        "Type": "Json",
+        "DataFileLocation": "test-data-azure-emissions.json"
+      }
+    }
+  }
+}
+```
 
 ## [1.0.0] - 2022-10-01