Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs fixes and release notes post for 1.6 #568

Merged
merged 9 commits into from
Sep 24, 2024
Merged

Docs fixes and release notes post for 1.6 #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
705e72e
fixes and release notes post for 1.6
danuw Sep 19, 2024
d3b054b
updated blog post
danuw Sep 24, 2024
f412591
docs workflow's node version updated to latest LTS -> 22
danuw Sep 24, 2024
2057c32
DCO Remediation Commit for Dan Benitah <[email protected]>
danuw Sep 24, 2024
cefcd73
blogs with truncate
danuw Sep 24, 2024
3d265a1
node version update back to 20
danuw Sep 24, 2024
eae5bd1
adding yarn.lock
danuw Sep 24, 2024
dfea675
pipelines fixes
danuw Sep 24, 2024
e8e7530
DCO Remediation Commit for Dan Benitah <[email protected]>
danuw Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/6-jekyll-gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ permissions:
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
Expand All @@ -31,7 +31,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 18
node-version: 20

- name: Copy Files
run: |
Expand Down
2 changes: 1 addition & 1 deletion casdk-docs/blog/2024-05-24-release-1.4.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Release 1.4

### Added

- [#401 Feature Contribution: Upgrade .NET version to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/401)
- [#401 Feature Contribution: Upgrade .NET version to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/401) <!-- truncate -->
- [#419 Feature Contribution: Migrate sample implementation of Azure Function to isolated worker model ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/419)
- [PR #500 Up Helm chart version to 1.2.0 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/500)

Expand Down
6 changes: 4 additions & 2 deletions casdk-docs/blog/2024-07-23-release-1.5.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Release 1.5

This is the WattTime v3 update. Most notable changes that may require action are for deployment configuration, and these are minor.

<!-- truncate -->

### Added

WattTime v3 API support. This is an inplace upgrade for v2.
Expand All @@ -19,7 +21,7 @@ WattTime v3 API support. This is an inplace upgrade for v2.
- [#510 Gap Analysis for WattTime v3 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/510)
- [#262 Feature Contribution: Publish the docker file in a docker registry ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/262)

### Removed
### Removed

WattTime v2 API support due to v3 in place replacement.

Expand All @@ -34,7 +36,7 @@ WattTime v2 API support due to v3 in place replacement.

### Changed

Updates for WattTime v3 API endpoint from v2, details in the [ADR for WattTime v3 changes](./casdk-docs/docs/architecture//decisions/0016-watt-time-v3.md).
Updates for WattTime v3 API endpoint from v2, details in the [ADR for WattTime v3 changes](/docs/architecture/decisions/watt-time-v3).

#### API

Expand Down
26 changes: 26 additions & 0 deletions casdk-docs/blog/2024-09-18-release-1.6.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
slug: release-v1.6
title: Release v1.6
tags: [v1.6, release]
---

Release 1.6

Release for milestone https://github.com/Green-Software-Foundation/carbon-aware-sdk/milestone/8?closed=1 with general bugs fixes and improvements

<!-- truncate -->

### Added

- [PR #555 Add a configuration for disabling to cache JSON emission data ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/555)
- [PR #544 Add env directive to values.yaml and troubleshooting guide to avoid inotify limitation on Linux ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/544)
- [PR #524 Add blog article for .NET 8 upgrade ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/524)
- [PR #523 documentation-change.yml: Created issue template for documentation ch… ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/523)

### Fixed

- [#528 Bug: Avoid inotify limit in WebAPI container on Kubernetes ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/528)
- [PR #553 Documentation: "it's" is used incorrectly several times ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/553)
- [PR #551 Docs/blog update for releases 1.3 to1.5 and fix ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/551)

For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/559](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/559)
10 changes: 5 additions & 5 deletions casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ The `Login` is now at a different base URL, and to avoid any future issues a dif

| API Endpoint | Description | Path (v2) | Path (v3) | Notes |
|--------------|-------------|-----------|-----------|---|
| Data | Get data | /data | /historical | _Request_ <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `ba` is now `region` <li> `signal_type` added <br> _Response_ <li> `signal_type` added |
| Forecast | Get forecast| /forecast | /forecast | <br> No longer be used for historical data <br> _Request_ <li> `ba` is now `region` <li> `extended_forecast` removed <li> `horizon_hours` added <li> `signal_type` added <li> Historical forecasts are now at `/forecast/historical` <br> _Response_ <li> `signal_type` added |
| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly. <br> _Request_ <li> `ba` is now `region` <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `signal_type` added <br> _Response_ <li> `signal_type` added |
| Balancing Authority From Location | Get balancing authority from location | /ba-from-loc | /region-from-loc | Check if the CA SDK uses BA at all <br><br> _Request_ <li> `name` is now `region_full_name` <li> `abbrev` is now `region` <li> `signal_type` added <br> _Response_ <li> `id` removed <li> `signal_type` added |
| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | Path has changed from being version specific to being no longer related to the API version. <br><br> Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login. |
| Data | Get data | /data | /historical | _Request_ <li> `starttime` is now `start` and mandatory </li><li> `endtime` is now `end` and mandatory </li><li> `ba` is now `region` </li><li> `signal_type` added <br /> _Response_ </li><li> `signal_type` added </li>|
| Forecast | Get forecast| /forecast | /forecast | <br /> No longer be used for historical data <br /> _Request_ <li> `ba` is now `region` </li><li> `extended_forecast` removed </li><li> `horizon_hours` added </li><li> `signal_type` added </li><li> Historical forecasts are now at `/forecast/historical` <br /> _Response_ </li><li> `signal_type` added </li>|
| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly. <br /> _Request_ <li> `ba` is now `region` </li><li> `starttime` is now `start` and mandatory </li><li> `endtime` is now `end` and mandatory </li><li> `signal_type` added <br /> _Response_ </li><li> `signal_type` added </li>|
| Balancing Authority From Location | Get balancing authority from location | /ba-from-loc | /region-from-loc | Check if the CA SDK uses BA at all <br /><br /> _Request_ <li> `name` is now `region_full_name` </li><li> `abbrev` is now `region` </li><li> `signal_type` added <br /> _Response_ </li><li> `id` removed </li><li> `signal_type` added </li> |
| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | Path has changed from being version specific to being no longer related to the API version. <br /><br /> Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login. |

### Query Strings

Expand Down
Loading
Loading