fix: use output environment files

.github/actions/operations/index.test.js

@@ -4,6 +4,8 @@ const { add, subtract, multiply } = require("./math");
 const process = require('process');
 const cp = require('child_process');
 const path = require('path');
+const fs = require('fs');
+const os = require('os');
 
 test('make sure it returns something', async () => {
   const core = {
@@ -29,17 +31,39 @@ test('make sure it returns something', async () => {
 
 describe("simple test", () => {
   it('test runs', () => {
+    const filePath = path.join(__dirname, `test_outputs.log`)
+    setupGitHubOutput(process, filePath);
+
     process.env['INPUT_INPUT1'] = 9;
     process.env['INPUT_INPUT2'] = 5;
 
     const ip = path.join(__dirname, 'index.js');
-    const result = cp.execSync(`node ${ip}`, { env: process.env }).toString();
-    expect(result).toContain("::set-output name=addition::14");
-    expect(result).toContain("::set-output name=subtraction::4");
-    expect(result).toContain("::set-output name=multiplication::45");
+    cp.execSync(`node ${ip}`, { env: process.env });
+
+    const contents = fs.readFileSync(filePath, 'utf8')
+    try {
+      verifyGitHubOutput(contents, "addition", "14");
+      verifyGitHubOutput(contents, "subtraction", "4");
+      verifyGitHubOutput(contents, "multiplication", "45");
+    } finally {
+      fs.unlinkSync(filePath)
+    }
   })
 });
 
+
+function setupGitHubOutput(process, filePath) {
+  process.env['GITHUB_OUTPUT'] = filePath;
+  fs.appendFileSync(filePath, '', {
+    encoding: 'utf8'
+  })
+}
+
+function verifyGitHubOutput(contents, expectedKey, expectedValue) {
+  const regex = `${expectedKey}<<ghadelimiter_.*${os.EOL}${expectedValue}${os.EOL}ghadelimiter_.*${os.EOL}`
+  expect(contents).toMatch(new RegExp(regex));
+}
+
 describe("simple arithmetic", () => {
   describe("addition", () => {
     test("expect 9 + 5 = 14", () => {

.github/actions/operations/package.json

@@ -8,7 +8,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@actions/core": "1.2.5"
+    "@actions/core": "^1.10.0"
   },
   "devDependencies": {
     "@vercel/ncc": "^0.31.1",

.github/actions/testable-action/action.yaml

@@ -7,9 +7,9 @@ inputs:
 outputs:
   value:
     description: output value
-    value: '${{ steps.final-output-value.outputs.outputValue }}'
+    value: "${{ steps.final-output-value.outputs.outputValue }}"
 runs:
-  using: 'composite'
+  using: "composite"
   steps:
     - run: |
         echo "OUTPUT_VALUE=output-${{ inputs.value }}" >> $GITHUB_ENV
@@ -23,5 +23,6 @@ runs:
       if: ${{ inputs.value == '' }}
 
     - id: final-output-value
-      run: echo "::set-output name=outputValue::${{ env.OUTPUT_VALUE }}"
+      run: |
+        echo "outputValue=${{ env.OUTPUT_VALUE }}" >> $GITHUB_OUTPUT
       shell: bash

docs/markdown/10-syntax/01-outputs.md

@@ -49,12 +49,12 @@ runs:
   image: 'Dockerfile'
 ```
 
-To define an output value, you need to print the `set-output` command.
+To define an output value, you can use the [GITHUB_OUTPUT](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter) environment file.
 
 **main.sh**
 
 ```sh
-echo "::set-output name=someOutput::Some Value"
+echo "someOutput=Some Value" >> $GITHUB_ENV
 ```
 
 Notes:
@@ -82,11 +82,11 @@ runs:
   using: 'composite'
   steps:
   - id: some-output-step
-    run: echo "::set-output name=someOutput::Some Value"
+    run: echo "someOutput=Some Value" >> $GITHUB_ENV
     shell: bash
 ```
 
-To define an output value, a step need to print the `set-output` command and you need to map it as value of the output.
+To define an output value, a step need to use the [GITHUB_OUTPUT](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter) environment file and then map it as value of the output of the action.
 
 Notes:
 

docs/markdown/20-interactions/02-communicate.md

@@ -16,6 +16,7 @@ Notes:
 Speaker **Romain**
 
 ##--##
+
 # Communicate
 
 ## Logging and annotations

docs/markdown/30-testing/01-javascript.md

@@ -54,7 +54,7 @@ Speaker **Thibauld**
 
 **Test suite**
 
-```js
+```js [1,19|2-6|8-12|14-18]
 describe("simple arithmetic", () => {
   describe("addition", () => {
     test("expect 9 + 5 = 14", () => {
@@ -90,17 +90,26 @@ For the operations **math.js** file, we can test its exposed function.
 
 **Run** the main file
 
-```js
+```js [9-10|6-7|3-4|12-19]
 describe("simple test", () => {
   it('test runs', () => {
+    const filePath = path.join(__dirname, `test_outputs.log`)
+    setupGitHubOutput(process, filePath);
+
     process.env['INPUT_INPUT1'] = 9;
     process.env['INPUT_INPUT2'] = 5;
 
     const ip = path.join(__dirname, 'index.js');
-    const result = cp.execSync(`node ${ip}`, { env: process.env }).toString();
-    expect(result).toContain("::set-output name=addition::14");
-    expect(result).toContain("::set-output name=subtraction::4");
-    expect(result).toContain("::set-output name=multiplication::45");
+    cp.execSync(`node ${ip}`, { env: process.env });
+
+    const contents = fs.readFileSync(filePath, 'utf8')
+    try {
+      verifyGitHubOutput(contents, "addition", "14");
+      verifyGitHubOutput(contents, "subtraction", "4");
+      verifyGitHubOutput(contents, "multiplication", "45");
+    } finally {
+      fs.unlinkSync(filePath)
+    }
   })
 });
 ```
@@ -117,7 +126,7 @@ Speaker **Thibauld**
 
 **Mock** some methods and test their usage.
 
-```js
+```js [13|2-9|10-12|14-20]
 test('make sure it returns something', async () => {
   const core = {
     getInput: jest.fn().mockResolvedValue(parseInt(43)),

steps/10-syntax-lab2-action-output-solution/action.yaml

@@ -1,5 +1,5 @@
-name: 'Syntax:Lab2'
-description: 'Action of Lab2 in Syntax section'
+name: "Syntax:Lab2"
+description: "Action of Lab2 in Syntax section"
 inputs:
   text:
     description: text
@@ -9,11 +9,11 @@ outputs:
     description: text in UPPER CASE
     value: ${{ steps.upper_step.outputs.upper_text }}
 runs:
-  using: 'composite'
+  using: "composite"
   steps:
     - id: upper_step
       run: |
-        echo "::set-output name=upper_text::${INPUT_TEXT^^}"
+        echo "upper_text=${INPUT_TEXT^^}" >> $GITHUB_OUTPUT
       env:
         INPUT_TEXT: ${{ inputs.text }}
       shell: bash

steps/20-interactions-lab1-warning-solution/package.json

@@ -7,7 +7,7 @@
     "prepare": "ncc build index.js -o dist --source-map"
   },
   "dependencies": {
-    "@actions/core": "^1.2.5",
+    "@actions/core": "^1.10.0",
     "@actions/glob": "^0.3.0"
   },
   "devDependencies": {

steps/20-interactions-lab1-warning/package.json

@@ -7,7 +7,7 @@
     "prepare": "ncc build index.js -o dist --source-map"
   },
   "dependencies": {
-    "@actions/core": "^1.2.5"
+    "@actions/core": "^1.10.0"
   },
   "devDependencies": {
     "@vercel/ncc": "^0.31.1"

steps/20-interactions-lab2-summary/package.json

@@ -7,7 +7,7 @@
     "prepare": "ncc build index.js -o dist --source-map"
   },
   "dependencies": {
-    "@actions/core": "^1.2.5",
+    "@actions/core": "^1.10.0",
     "@actions/glob": "^0.3.0"
   },
   "devDependencies": {

steps/30-testing-lab2-action-workflow-testing/action.yaml

@@ -37,14 +37,14 @@ runs:
         ADD2: ${{ inputs.addition-input-2 }}
       run: |
         OUTPUT_VALUE=$(sh scripts/addition.sh $ADD1 $ADD2)
-        echo "::set-output name=outputAdditionValue::$OUTPUT_VALUE"
+        echo "outputAdditionValue=$OUTPUT_VALUE" >> $GITHUB_OUTPUT
       shell: bash
 
     - name: run hello-world
       id: hello-world
       run: |
         OUTPUT_VALUE=$(sh scripts/hello-world.sh)
-        echo "::set-output name=outputHelloWorldValue::$OUTPUT_VALUE"
+        echo "outputHelloWorldValue=$OUTPUT_VALUE" >> $GITHUB_OUTPUT
       shell: bash
 
     - name: run palindrome
@@ -53,5 +53,5 @@ runs:
         PAL: ${{ inputs.palindrome-input }}
       run: |
         OUTPUT_VALUE=$(sh scripts/palindrome.sh $PAL)
-        echo "::set-output name=outputPalindromeValue::$OUTPUT_VALUE"
+        echo "outputPalindromeValue=$OUTPUT_VALUE" >> $GITHUB_OUTPUT
       shell: bash

steps/50-lifecycle-lab2-dist/package.json

@@ -7,7 +7,7 @@
     "prepare": "ncc build index.js -o dist --source-map"
   },
   "dependencies": {
-    "@actions/core": "^1.2.5"
+    "@actions/core": "^1.10.0"
   },
   "devDependencies": {
     "@vercel/ncc": "^0.31.1"