diff --git a/casdk-docs/blog/2022-10-01-release-1.0.mdx b/casdk-docs/blog/2022-10-01-release-1.0.mdx new file mode 100644 index 000000000..d7ef5e8f2 --- /dev/null +++ b/casdk-docs/blog/2022-10-01-release-1.0.mdx @@ -0,0 +1,90 @@ +--- +slug: release-v1.1 +title: Release v1.1 +tags: [v1.1, release] +--- + +Release 1.1 + + + +## [1.1.0] - 2023-18-07 + +### Added + +- Added Electricity Maps (paid api) support for forecasting and historical data. +- Added ElectricityMaps (free api) support for historical data. Note that this API does not support forecast capabilities. + +### 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` - 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 + +- 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 - [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" + } + } + } +} +``` + diff --git a/casdk-docs/blog/2023-07-18-release-1.1.mdx b/casdk-docs/blog/2023-07-18-release-1.1.mdx new file mode 100644 index 000000000..d7ef5e8f2 --- /dev/null +++ b/casdk-docs/blog/2023-07-18-release-1.1.mdx @@ -0,0 +1,90 @@ +--- +slug: release-v1.1 +title: Release v1.1 +tags: [v1.1, release] +--- + +Release 1.1 + + + +## [1.1.0] - 2023-18-07 + +### Added + +- Added Electricity Maps (paid api) support for forecasting and historical data. +- Added ElectricityMaps (free api) support for historical data. Note that this API does not support forecast capabilities. + +### 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` - 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 + +- 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 - [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" + } + } + } +} +``` + diff --git a/casdk-docs/blog/2023-08-01-mdx-blog-post.mdx b/casdk-docs/blog/2023-08-01-mdx-blog-post.mdx deleted file mode 100644 index f5e5f3473..000000000 --- a/casdk-docs/blog/2023-08-01-mdx-blog-post.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -slug: release-v1.1 -title: Release v1.1 -tags: [v1.1, release] ---- - -Release 1.1 - -:::tip - -Use the power of React to create interactive blog posts. - -```js - -``` - - - -::: diff --git a/casdk-docs/blog/2024-01-14-release-1.2.mdx b/casdk-docs/blog/2024-01-14-release-1.2.mdx new file mode 100644 index 000000000..cb9f2dce5 --- /dev/null +++ b/casdk-docs/blog/2024-01-14-release-1.2.mdx @@ -0,0 +1,45 @@ +--- +slug: release-v1.2 +title: Release v1.2 +tags: [v1.2, release] +--- + +Release 1.2 + +## [1.2.0] - 2024-01 + +### Added + +- [#381 Add Helm chart and workflow](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/381) +- New package release for Helm charts available at https://github.com/Green-Software-Foundation/carbon-aware-sdk/pkgs/container/charts%2Fcarbon-aware-sdk + +### Fixed + +- [#232 Generating SDK client does not work on linux](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/232) +- [#393 Fix: verify-azure-function-with-packages](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/393) +- [#391 fixing 3 broken links in overview.md](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/391) +- [#389 EMFree data source should regard specified time range](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/389) + +### Changed + +- [#425 Updating CONTRIBUTING.md](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/425) + +#### API + +- + +#### API Deployment + +- + +#### SDK + +- + + +#### Other + +- Improved process leveraging the project boards at https://github.com/orgs/Green-Software-Foundation/projects/15/views/2 + + +For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/232](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues?q=label%3Av1.2+is%3Aclosed+) \ No newline at end of file diff --git a/casdk-docs/blog_preview/2024-02-13-release-1.3.mdx b/casdk-docs/blog_preview/2024-02-13-release-1.3.mdx new file mode 100644 index 000000000..3ff9ae472 --- /dev/null +++ b/casdk-docs/blog_preview/2024-02-13-release-1.3.mdx @@ -0,0 +1,42 @@ +--- +slug: release-v1.3 +title: Release v1.3 +tags: [v1.3, release] +--- + +Release 1.3 + + + + +### Added + +- + +### Fixed + +- + +### Changed + +- + +#### API + +- + +#### API Deployment + +- + +#### SDK + +- + + +#### Other + +- Improved process leveraging the project boards at https://github.com/orgs/Green-Software-Foundation/projects/15/views/2 + + +For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues?q=label%3Av1.3+is%3Aclosed+](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues?q=label%3Av1.3+is%3Aclosed+) \ No newline at end of file diff --git a/casdk-docs/docusaurus.config.js b/casdk-docs/docusaurus.config.js index dc8e34ba6..ea7fa337b 100644 --- a/casdk-docs/docusaurus.config.js +++ b/casdk-docs/docusaurus.config.js @@ -72,6 +72,7 @@ const config = { position: 'left', label: 'Tutorial', }, + {to: '/blog', label: 'Blog', position: 'left'}, {to: 'https://greensoftware.foundation/', label: 'GSF', position: 'left'}, { href: 'https://github.com/Green-Software-Foundation/carbon-aware-sdk',