Merge pull request #947 from Green-Software-Foundation/release-v0.6.0…

…-beta.0

Release v0.6.0-beta.0

.github/workflows/dispatch-integration-test.yml

@@ -0,0 +1,23 @@
+name: Run if-check on requested branch
+
+on: 
+  workflow_dispatch: 
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run integration tests
+        run: npm run if-check -- -d manifests/outputs

.github/workflows/nodejs-ci.yml

@@ -3,21 +3,83 @@ on: push
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write # this allows to show carbon and energy data table in PRs
     steps:
+      - name: Eco CI Energy Estimation - Initialize
+        uses: green-coding-solutions/[email protected]
+
+        with:
+          task: start-measurement
+        continue-on-error: true
+
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Eco CI Energy Estimation - Get Measurement
+        uses: green-coding-solutions/[email protected]
+
+        with:
+          task: get-measurement
+          label: "checkout"
+        continue-on-error: true
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 18
           cache: 'npm'
 
+      - name: Eco CI Energy Estimation - Get Measurement
+        uses: green-coding-solutions/[email protected]
+
+        with:
+          task: get-measurement
+          label: "setup node"
+        continue-on-error: true
+
+
       - name: Install dependencies
         run: npm install
 
+      - name: Eco CI Energy Estimation - Get Measurement
+        uses: green-coding-solutions/[email protected]
+
+        with:
+          task: get-measurement
+          label: "npm install"
+        continue-on-error: true
+
+
       - name: Run lint
         run: npm run lint
+
+      - name: Eco CI Energy Estimation - Get Measurement
+        uses: green-coding-solutions/[email protected]
+
+        with:
+          task: get-measurement
+          label: "npm run lint"
+        continue-on-error: true
+
 
       - name: Run unit tests
         run: npm run test --silent
+
+      - name: Eco CI Energy Estimation - Get Measurement
+        uses: green-coding-solutions/[email protected]
+
+        with:
+          task: get-measurement
+          label: "npm run test"
+        continue-on-error: true
+
+      - name: Eco CI Energy Estimation - End Measurement
+        uses: green-coding-solutions/[email protected]
+
+        with:
+          task: display-results
+          send-data: true
+          pr-comment: true
+        continue-on-error: true
+

.github/workflows/release-commit.yml

@@ -8,7 +8,7 @@ env:
   PRE_RELEASE: ${{ github.event.release.prerelease}}
 
 jobs:
-  release-commit-pr:
+  unit-tests:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -28,9 +28,45 @@ jobs:
       - name: Run unit tests
         run: npm test
 
+  integration-tests:
+    runs-on: ubuntu-latest
+    needs: unit-tests
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.repository.default_branch }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm ci
+
       - name: Run integration tests
         run: npm run if-check -- -d manifests/outputs
 
+  publish:
+    runs-on: ubuntu-latest
+    needs: integration-tests
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.repository.default_branch }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm ci
+
       - name: Initialize git user email
         run: git config --global user.email "${{ vars.RELEASE_USER_EMAIL }}"
 

README.md

@@ -19,7 +19,7 @@ Read the [specification and design docs](https://if.greensoftware.foundation) to
 
 ## Get started
 
-IF is a framework for running pipelines of plugins that operate on a set of observations. This is all configured using a manifest file.  We provide a standard library of plugins that come bundled with IF - we refer to these as `builtins`. We also have an [Explorer](https://explorer.if.greensoftware.foundation) where anyone can list third party plugins you can install.
+IF is a framework for running pipelines of plugins that operate on a set of observations. This is all configured using a manifest file. We provide a standard library of plugins that come bundled with IF - we refer to these as `builtins`. We also have an [Explorer](https://explorer.if.greensoftware.foundation) where anyone can list third party plugins you can install.
 
 Start by installing the latest version of IF:
 
@@ -32,26 +32,18 @@ Then create a `manifest` file that describes your application (see our docs for
 Then, run `if` using the following command:
 
 ```sh
-if-run --manifest <path-to-your-manifest-file> --stdout
-## or you can use aliases
-if-run -m <path-to-your-manifest-file> -s
+if-run --manifest <path-to-your-manifest-file>
+## or you can use alias
+if-run -m <path-to-your-manifest-file>
 
 ```
 
-Note that above command will print your outputs to the console. You can also provide the `--output` command to save your outputs to a yaml file:
+Note that above command will print your outputs to the console. If you do not want to print the outputs to the console, you need to provide `--no-output` command. You can also provide the `--output` command to save your outputs to a yaml file:
 
 ```sh
 if-run -m <path-to-your-manifest> -o <savepath>
 ```
 
-Note that you also have to add configuration to your manifest to enable this, as follows:
-
-```yaml
-initialize:
-  output:
-    - yaml
-```
-
 The `if-run` CLI tool will configure and run the plugins defined in your input `yaml` (`manifest`) and return the results as an output `yaml` (`output`).
 
 Use the `debug` command if you want to diagnose and fix errors in your plugin:
@@ -72,19 +64,16 @@ if-run -h
 
 Please read our documentation at [if.greensoftware.foundation](https://if.greensoftware.foundation/)
 
-
 ## Video walk-through
 
 Watch this video to learn how to create and run a `manifest`.
 
 [![Watch the walk-through video](https://i3.ytimg.com/vi/R-6eDM8AsvY/maxresdefault.jpg)](https://youtu.be/GW37Qd4AQbU)
 
-
 ## Join our mailing list
 
 We have a public mailing list at [[email protected]](https://groups.google.com/u/1/a/greensoftware.foundation/g/if-community). We send out weekly updates that explain what we've shipped, what we're working on and how you can get involved each week!
 
-
 ## Contributing
 
 To contribute to IF, please fork this repository and raise a pull request from your fork.
@@ -93,7 +82,6 @@ You can check our issue board for issues. We mark some issues `core-only` if the
 
 Please read the full contribution guidelines at [if.greensoftware.foundation](https://if.greensoftware.foundation/Contributing)
 
-
 ## Bug reports
 
 To report bugs please use our bug report template. You can do this by opening a new issue and selecting `Bug Report` when you are prompted to pick a template. The more information you provide,.the quicker we will be able to reproduce, diagnose and triage your issue.