Release 1.7.0

.devcontainer/devcontainer.json

@@ -32,7 +32,9 @@
 
 	// Uncomment the line below to mount your local usersecrets into the devcontainer from a Mac/Linux OS
 	// "mounts": [ "source=${localEnv:HOME}/.microsoft/usersecrets,target=/root/.microsoft/usersecrets,type=bind" ],
-
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {}
+	},
 
 	// Add the IDs of extensions you want installed when the container is created in the array below.
 	"customizations": {

.github/workflows/4-release.yaml

@@ -9,8 +9,17 @@ env:
   IMAGE_NAME: ${{ github.repository }}
 
 jobs:
+  detect-current-api-version:
+    uses: ./.github/workflows/detect-webapi-version.yaml
+    with:
+      # We cannot use environment variables here due to workflow limitation.
+      # https://docs.github.com/en/enterprise-cloud@latest/actions/using-workflows/reusing-workflows#limitations
+      registry: ghcr.io
+      image-repo: ${{ github.repository }}
+
   publish-container-image:
     runs-on: ubuntu-latest
+    needs: detect-current-api-version
     permissions:
       packages: write
     steps:
@@ -39,3 +48,28 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           provenance: false
+
+  detect-newer-api-version:
+    needs: publish-container-image
+    uses: ./.github/workflows/detect-webapi-version.yaml
+    with:
+      # We cannot use environment variables here due to workflow limitation.
+      # https://docs.github.com/en/enterprise-cloud@latest/actions/using-workflows/reusing-workflows#limitations
+      registry: ghcr.io
+      image-repo: ${{ github.repository }}
+
+  generate-webapi-clients:
+    needs:
+      - detect-current-api-version
+      - detect-newer-api-version
+    if: ${{ needs.detect-current-api-version.outputs.apiver != needs.detect-newer-api-version.outputs.apiver }}
+    uses: ./.github/workflows/4.a-generate-webapi-clients.yaml
+    permissions:
+      contents: write
+      packages: write
+      pull-requests: write
+    with:
+      # We cannot use environment variables here due to workflow limitation.
+      # https://docs.github.com/en/enterprise-cloud@latest/actions/using-workflows/reusing-workflows#limitations
+      registry: ghcr.io
+      image-repo: ${{ github.repository }}

.github/workflows/4.a-generate-webapi-clients.yaml

@@ -0,0 +1,89 @@
+name: 4.a-Generate WebAPI client libraries
+
+on:
+  workflow_call:
+    inputs:
+      registry:
+        type: string
+        required: true
+      image-repo:
+        type: string
+        required: true
+      tag:
+        type: string
+        required: false
+        default: latest
+  workflow_dispatch:
+    inputs:
+      registry:
+        type: string
+        required: false
+        default: ghcr.io
+      image-repo:
+        type: string
+        required: false
+        default: "green-software-foundation/carbon-aware-sdk"
+      tag:
+        type: string
+        required: false
+        default: latest
+
+permissions:
+  contents: write
+  packages: write
+  pull-requests: write
+
+jobs:
+  detect-api-version:
+    uses: ./.github/workflows/detect-webapi-version.yaml
+    with:
+      registry: ${{ inputs.registry }}
+      image-repo: ${{ inputs.image-repo }}
+      tag: ${{ inputs.tag }}
+
+  generate-java-client:
+    needs: detect-api-version
+    uses: ./.github/workflows/4.a.1-generate-webapi-client-java.yaml
+    with:
+      image: ${{ needs.detect-api-version.outputs.image }}
+      apiver: ${{ needs.detect-api-version.outputs.apiver }}
+
+  generate-npm-client:
+    needs: detect-api-version
+    uses: ./.github/workflows/4.a.1-generate-webapi-client-npm.yaml
+    with:
+      image: ${{ needs.detect-api-version.outputs.image }}
+      apiver: ${{ needs.detect-api-version.outputs.apiver }}
+
+  push-apidocs:
+    runs-on: ubuntu-latest
+    needs:
+      - detect-api-version
+      - generate-java-client
+      - generate-npm-client
+    env:
+      DOCPATH: casdk-docs/static/client-apidocs/${{ needs.detect-api-version.outputs.apiver }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: dev
+      - name: Extract Javadoc
+        uses: actions/download-artifact@v4
+        with:
+          name: javadoc
+          path: ${{ env.DOCPATH }}/java
+      - name: Extract TypeDoc
+        uses: actions/download-artifact@v4
+        with:
+          name: typedoc
+          path: ${{ env.DOCPATH }}/npm
+      - name: Create PR for Client API docs
+        uses: peter-evans/create-pull-request@v7
+        with:
+          commit-message: "Add Client API documents for WebAPI ${{ needs.detect-api-version.outputs.apiver }}"
+          branch: gha/pr/webapidoc-${{ needs.detect-api-version.outputs.apiver }}
+          delete-branch: true
+          title: "Add Client API documents for WebAPI ${{ needs.detect-api-version.outputs.apiver }}"
+          body: |
+            This PR has been created by 4.a-generate-webapi-clients.yaml due to WebAPI version update.

.github/workflows/4.a.1-generate-webapi-client-java.yaml

@@ -0,0 +1,56 @@
+name: 4.a.1-Generate WebAPI client library for Java
+
+on:
+  workflow_call:
+    inputs:
+      image:
+        required: true
+        type: string
+      apiver:
+        required: true
+        type: string
+
+jobs:
+  generate-java-client:
+    runs-on: ubuntu-latest
+    services:
+      webapi:
+        image: ${{ inputs.image }}
+        ports:
+          - 8080:8080
+        options: >-
+          --health-cmd "curl -sS http://localhost:8080/health"
+          --health-interval 3s
+          --health-timeout 5s
+          --health-retries 5
+    permissions:
+      packages: write
+    env:
+      API: http://localhost:8080/api/v1/swagger.yaml
+    steps:
+      - name: Prepare
+        run: |
+          mkdir work pages
+          npm install -g @openapitools/[email protected]
+      - name: Generate client library
+        run: |
+          echo '{"apiPackage": "foundation.greensoftware.carbonaware.webapi.client", "artifactDescription": "Carbon Aware SDK client library for Java", "artifactId": "casdk-client", "artifactVersion": "${{ inputs.apiver }}", "developerOrganization": "Green Software Foundation", "developerOrganizationUrl": "https://greensoftware.foundation/", "groupId": "foundation.greensoftware", "licenseName": "MIT License", "scmUrl": "${{ env.REPO }}", "artifactUrl": "${{ env.REPO }}/packages/", "scmConnection": "${{ github.repositoryUrl }}", "scmDeveloperConnection": "${{ github.repositoryUrl }}", "licenseUrl": "https://opensource.org/license/mit/", "developerName": "Green Software Foundation", "developerEmail": "[email protected]"}' > config.json
+          openapi-generator-cli generate -i ${{ env.API }} -g java -o work -c config.json
+          sed -i "s|</project>|<distributionManagement><repository><id>github</id><name>GitHub Packages</name><url>https://maven.pkg.github.com/${{ github.repository }}</url></repository></distributionManagement></project>|" work/pom.xml
+        shell: bash
+      - name: Setup Java 8
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 8
+          cache: maven
+      - name: Run Maven
+        run: mvn -B deploy javadoc:javadoc
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        working-directory: work
+      - name: Upload Javadoc
+        uses: actions/upload-artifact@v4
+        with:
+          name: javadoc
+          path: work/target/apidocs

.github/workflows/4.a.1-generate-webapi-client-npm.yaml

@@ -0,0 +1,65 @@
+name: 4.a.1-Generate WebAPI client library for NPM
+
+on:
+  workflow_call:
+    inputs:
+      image:
+        required: true
+        type: string
+      apiver:
+        required: true
+        type: string
+
+jobs:
+  generate-npm-client:
+    runs-on: ubuntu-latest
+    services:
+      webapi:
+        image: ${{ inputs.image }}
+        ports:
+          - 8080:8080
+        options: >-
+          --health-cmd "curl -sS http://localhost:8080/health"
+          --health-interval 3s
+          --health-timeout 5s
+          --health-retries 5
+    permissions:
+      packages: write
+    env:
+      API: http://localhost:8080/api/v1/swagger.yaml
+    steps:
+      - name: Setup Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          registry-url: https://npm.pkg.github.com
+      - name: Prepare
+        run: |
+          mkdir work
+          npm install -g @openapitools/[email protected]
+      - name: Generate client library
+        run: |
+          echo -n '{"npmName": "@${{ github.repository_owner }}/casdk-client", "npmVersion": "${{ inputs.apiver  }}", "licenseName": "MIT", "gitUserId": "${{ github.repository_owner }}", "gitRepoId": "' > config.json
+          echo -n "${{ github.repository  }}" | sed -e 's|^.\+/||' >> config.json
+          echo -n '", "npmRepository": "https://npm.pkg.github.com"}' >> config.json
+          openapi-generator-cli generate -i ${{ env.API }} -g typescript-axios -o work -c config.json
+        shell: bash
+      - name: Publish NPM library
+        working-directory: work
+        run: |
+          npm install
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ github.token }}
+      - name: Setup TypeDoc
+        run: npm install -g typedoc
+      - name: Generate documents
+        working-directory: work
+        run: |
+          echo '{"out": "docs", "excludePrivate": true, "excludeProtected": true, "excludeExternals": true, "includeVersion": true}' > ../typedoc.json
+          npx typedoc --options ../typedoc.json --entryPoints index.ts
+      - name: Upload TypeDoc
+        uses: actions/upload-artifact@v4
+        with:
+          name: typedoc
+          path: docs

.github/workflows/detect-webapi-version.yaml

@@ -0,0 +1,55 @@
+name: Detect API version from OpenAPI document in WebAPI container image
+
+on:
+  workflow_call:
+    inputs:
+      registry:
+        type: string
+        required: true
+      image-repo:
+        type: string
+        required: true
+      tag:
+        type: string
+        required: false
+        default: latest
+    outputs:
+      image:
+        value: ${{ jobs.make-image-name-for-pull.outputs.image }}
+      apiver:
+        value: ${{ jobs.detect-api-version.outputs.apiver }}
+
+jobs:
+  make-image-name-for-pull:
+    runs-on: ubuntu-latest
+    outputs:
+      image: ${{ steps.make-image-name.outputs.IMAGE_NAME }}
+    steps:
+      - name: Make string for pulling container image
+        id: make-image-name
+        run: |
+          REPO=${{ inputs.registry }}/${{ inputs.image-repo }}
+          REPO_LOWER=${REPO,,}
+          echo "IMAGE_NAME=$REPO_LOWER:${{ inputs.tag }}" >> "$GITHUB_OUTPUT"
+
+  detect-api-version:
+    needs: make-image-name-for-pull
+    runs-on: ubuntu-latest
+    services:
+      webapi:
+        image: ${{ needs.make-image-name-for-pull.outputs.image }}
+        ports:
+          - 8080:8080
+        options: >-
+          --health-cmd "curl -sS http://localhost:8080/health"
+          --health-interval 3s
+          --health-timeout 5s
+          --health-retries 5
+    outputs:
+      apiver: ${{ steps.detect-api-version.outputs.CURRENT_API_VERSION }}
+    steps:
+      - name: Detect API version
+        id: detect-api-version
+        run: |
+          API_VERSION=`curl -sS http://localhost:8080/api/v1/swagger.yaml | yq -r .info.version`
+          echo "CURRENT_API_VERSION=$API_VERSION" >> "$GITHUB_OUTPUT"

.gitignore

@@ -34,4 +34,5 @@ src/data/location-sources/custom-azure-zones.json
 # exclude artifacts on java-client example
 samples/java-client/target
 
-casdk-docs/docs/samples/*
+casdk-docs/docs/samples/*
+node_modules/

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to the Carbon Aware SDK will be documented in this file.
 
+## [1.7] - 2025-01
+
+This release mainly introduces new clients libraries for NPM and Java [https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.7](https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.7) 
+
+### Added
+
+- [PR #591] Publish WebAPI client library for NPM ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/591)
+- [PR #597] Add Client API documents for WebAPI 1.0.0 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/597)
+- [PR #588] Add gh cli to devcontainer/codespace ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/588)
+- [PR #471] Add GHA workflow for generating WebAPI client library for Java ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/471)
+
+### Fixed 
+
+- [#571] [Bug]: Cannot get the value of a token type 'Null' as a number ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/571)
+- [#570] [Bug]:  webapi query on bylocation shows 24 hours worth of data even when smaller range requested ](https://github.com/Green-Software-Foundation/carbon-aware-
+sdk/issues/570)
+
+For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/601](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/601)
+
 ## [1.6.1] - 2024-11
 
 Release addressing minor issues [https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.6.1](https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.6.1) 

casdk-docs/blog/2024-11-30-relese1.6.1.mdx

@@ -0,0 +1,23 @@
+---
+slug: release-v1.6.1
+title: Release v1.6.1
+tags: [v1.6.1, release]
+---
+
+Release 1.6.1
+
+
+Release addressing minor issues [https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.6.1](https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.6.1) 
+
+<!-- truncate -->
+
+### Added
+
+- [PR #531] Add configuration for tracing log](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/531)
+
+### Fixed 
+
+- [PR #575] Consider null value in carbonIntensity on EM ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/575)
+- [PR #572] EM datasource didn't filter out-of-range emission data ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/572)
+
+For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/579](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/579)