Merge branch 'dev' into pr/remove-jsons

Signed-off-by: Yasumasa Suenaga <[email protected]>

Author: YaSuenag

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/dotnet/sdk:6.0
+FROM mcr.microsoft.com/dotnet/sdk:8.0
 
 RUN apt-get update
 

.devcontainer/devcontainer.json

@@ -13,6 +13,13 @@
 	// Use 'appPort' to create a container with published ports. If the port isn't working, be sure
 	// your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost.
 	// "appPort": [],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	"forwardPorts": [5073],
+	// "portsAttributes": {
+	//   "5073": {
+	//     "protocol": "https"
+	//   }
+	// },
 
 	// Uncomment the next line to run commands after the container is created.
 	// "postCreateCommand": "rustc --version",
@@ -25,9 +32,22 @@
 
 	// 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.
-	"extensions": [
-		"ms-dotnettools.csharp"	
-	]
+	"customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-vscode.vscode-node-azure-pack",
+                "GitHub.copilot",
+                "GitHub.vscode-github-actions",
+				"GitHub.copilot-chat",
+                "ms-dotnettools.vscode-dotnet-runtime",
+                "ms-dotnettools.csdevkit",
+                "ms-dotnetools.csharp"
+            ]
+        }
+    }
 }

.github/ISSUE_TEMPLATE/agenda-template.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 ## Date
-YYYY-MM-DD - 8am UTC
+YYYY-MM-DD - 7am UTC
 
 ## Meeting notices
 
@@ -18,7 +18,7 @@ Linux Foundation meetings involve participation by industry competitors, and it
 Examples of types of actions that are prohibited at Linux Foundation meetings and in connection with Linux Foundation activities are described in the Linux Foundation Antitrust Policy available at http://www.linuxfoundation.org/antitrust-policy. If you have questions about these matters, please contact your company counsel, or if you are a member of the Linux Foundation, feel free to contact Andrew Updegrove of the firm of Gesmer Updegrove LLP, which provides legal counsel to the Linux Foundation.
 
 ### Recordings
-GSF project meetings may be recorded for use solely by the GSF team for administration purposes. In very limited instances, and with explicit approval, recordings may be made more widely available.
+We're happy to start recording these meetings if we receive any requests to record them.
 
 ### Roll Call 
 Please *add a comment* to this issue during the meeting to denote attendance.

.github/ISSUE_TEMPLATE/case-study-template.md

@@ -0,0 +1,62 @@
+---
+name: Case-study template
+about: Case-study submissions
+title: Case-study submissions
+labels: Case-study submissions
+assignees: vaughanknight
+
+---
+
+# Case Study Template
+
+*This is a template to use for case studies that are submitted that leverage the Carbon Aware SDK. These case studies will be published to the Carbon Aware SDK repository*
+
+> We will contact the person who created this issue to follow up prior to publishing any case studies for clarification and alignment
+
+*Please delete the text in italics and replace it with the appropriate information.*
+
+*For more information on any of the items, the final reference is the [SCI Specification](https://github.com/Green-Software-Foundation/software_carbon_intensity/blob/main/Software_Carbon_Intensity/Software_Carbon_Intensity_Specification.md)*
+
+*If you find errors, or have further questions, please feel free to raise an [issue](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues).*
+
+## Overview
+
+_Please provide information describing the use case in a few bullet points_
+
+## Describe the solution that implements the Carbon Aware SDK
+
+_A textual description of the solution that implements the Carbon Aware SDK_
+
+_A textual description of the action that is taken that reduces emissiosn due to leveraging the Carbon Aware SDK_
+
+## Architecture for the solution (if applicable)
+
+_An architecture diagram of the solution described in this use case_
+
+### Technical details of the components in the architecture
+
+_Textual description with technical details of each component provided in the architecture diagram_
+
+## Carbon Aware SDK impact (both emissions impact and business impact)
+
+_Textual description of the emissions impact and how it was measured_
+
+_Textual description of the business impact beyond the emissions impact (if applicable)_
+
+## Any public press release information that relates to the 
+
+_Titles and links to press releases that can be viewed publicly online_ 
+
+## Any other notes of significance 
+
+_For example_
+
+_Was the SCI used?_
+
+_Was this built in conjuction with another party that should be included in the case study?_
+
+_Was there a contribution back to the Carbon Aware SDK project as part of this?_
+
+_Are there any further plans to implement the Carbon Aware SDK across other solutions that can be discussed?_
+
+_Are there any further plans to leverage other aspects of the Green Software Foundation to drive positive impact with software?_

.github/ISSUE_TEMPLATE/documentation-change.yml

@@ -0,0 +1,36 @@
+name: Documentation Change
+description: Suggest a change to documentation
+title: "Documentation: "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for helping us maintain the CASDK documentation! If you'd just like to fix spelling/typos in the current documentation,
+        feel free to submit a pull request without raising an issue. If you'd like to change the content of current documentation,
+        please submit this issue to explain the purpose of the change.
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. [email protected]
+    validations:
+      required: false
+  - type: textarea
+    id: overview
+    attributes:
+      label: Overview of Change
+      description: Please give a brief overview of your intended change. What is the purpose of the change and what content will be impacted?
+      placeholder: Explain change
+      value: "Describe change"
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow the [Way We Work](https://github.com/Green-Software-Foundation/standards_wg/blob/main/the_way_we_work.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/workflows/1-pr.yaml

@@ -8,7 +8,7 @@ env:
   # web app
   DOCKERFILE_PATH: "CarbonAware.WebApi/src/Dockerfile"
   HEALTH_ENDPOINT: "0.0.0.0:8080/health"
-  DLL_FILE_PATH: "./bin/Release/net6.0/CarbonAware.WebApi.dll"
+  DLL_FILE_PATH: "./bin/Release/net8.0/CarbonAware.WebApi.dll"
   DOTNET_SRC_DIR: "./src"
   # console app packages
   DOTNET_SOLUTION: "src/GSF.CarbonAware/src/GSF.CarbonAware.csproj"
@@ -40,9 +40,9 @@ jobs:
 
     - uses: actions/checkout@v2
     - name: Setup .NET
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 6.0.x
+        dotnet-version: 8.0.x
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
@@ -86,14 +86,14 @@ jobs:
     needs: sln-build-and-test
     runs-on: ubuntu-latest
     container:
-      image: mcr.microsoft.com/dotnet/sdk:6.0
+      image: mcr.microsoft.com/dotnet/sdk:8.0
     steps:
       - uses: actions/checkout@v3
 
-      - name: Setup .NET Core SDK 6
-        uses: actions/setup-dotnet@v2
+      - name: Setup .NET Core SDK 8
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
           include-prerelease: false
 
       - name: Install dependencies
@@ -126,10 +126,12 @@ jobs:
           DataSources__EmissionsDataSource: Json
           DataSources__Configurations__Json__Type: JSON
         run: dotnet tool run swagger tofile --output ./wwwroot/api/v1/swagger.yaml --yaml ${{ env.DLL_FILE_PATH }} v1
+        env:
+          DOTNET_ROLL_FORWARD: LatestMajor
         working-directory: ./src/CarbonAware.WebApi/src 
 
       - name: Upload swagger artifact
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: pr-swagger.yaml
           path: src/CarbonAware.WebApi/src/wwwroot/api/v1/swagger.yaml
@@ -147,7 +149,7 @@ jobs:
 
       - name: Docker Run Container
         run: |
-          docker run -d --name runnable-container -e DataSources__EmissionsDataSource=Json -e DataSources__Configurations__Json__Type=JSON -p 8080:80 ca-api
+          docker run -d --name runnable-container -e DataSources__EmissionsDataSource=Json -e DataSources__Configurations__Json__Type=JSON -p 8080:8080 ca-api
           docker container ls
 
       - name: Docker WGET Health Endpoint
@@ -167,10 +169,10 @@ jobs:
         uses: actions/checkout@v3
         with:
           ref: dev
-      - name: Setup .NET Core SDK 6
-        uses: actions/setup-dotnet@v2
+      - name: Setup .NET Core SDK 8
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
           include-prerelease: false
       - name: Install dependencies
         run: dotnet restore
@@ -182,12 +184,14 @@ jobs:
         working-directory: ${{ env.DOTNET_SRC_DIR }}
       - name: Generate Open API
         run: dotnet tool run swagger tofile --output ./wwwroot/api/v1/swagger.yaml --yaml ${{ env.DLL_FILE_PATH }} v1
+        env:
+          DOTNET_ROLL_FORWARD: LatestMajor
       - name: Upload dev artifact
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: dev-swagger.yaml
           path: src/CarbonAware.WebApi/src/wwwroot/api/v1/swagger.yaml
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: pr-swagger.yaml
           path: ./src/CarbonAware.WebApi/src/wwwroot/api/v1/pr-swagger.yaml
@@ -202,10 +206,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Setup .NET Core SDK 6
-        uses: actions/setup-dotnet@v2
+      - name: Setup .NET Core SDK 8
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
           include-prerelease: false
 
       - name: Create packages

.github/workflows/2-pre-release.yaml

@@ -23,8 +23,6 @@ jobs:
     permissions:
       packages: write
     steps:
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       - name: Log in to the Container registry

.github/workflows/2.a-deploy.yaml renamed to .github/workflows/2.a-deploy.yaml.ignore

@@ -9,13 +9,20 @@ 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:
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       - name: Log in to the Container registry
@@ -41,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 }}