Release 0.7.0 (#218)

* Expose CI=true and GITHUB_ACTIONS env variables

* fmt

* revert the prettier and finish this

* revert package-lock.json

examples/prepare-job.json

@@ -4,7 +4,7 @@
   "state": {},
   "args": {
     "container": {
-      "image": "node:14.16",
+      "image": "node:22",
       "workingDirectory": "/__w/repo/repo",
       "createOptions": "--cpus 1",
       "environmentVariables": {

examples/run-container-step.json

@@ -9,7 +9,7 @@
     }
   },
   "args": {
-    "image": "node:14.16",
+    "image": "node:22",
     "dockerfile": null,
     "entryPointArgs": [
       "-e",

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "hooks",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "hooks",
-      "version": "0.6.2",
+      "version": "0.7.0",
       "license": "MIT",
       "devDependencies": {
         "@types/jest": "^27.5.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hooks",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "Three projects are included - k8s: a kubernetes hook implementation that spins up pods dynamically to run a job - docker: A hook implementation of the runner's docker implementation  - A hook lib, which contains shared typescript definitions and utilities that the other packages consume",
   "main": "",
   "directories": {

packages/docker/package.json

@@ -5,7 +5,10 @@
   "main": "lib/index.js",
   "scripts": {
     "test": "jest --runInBand",
-    "build": "npx tsc && npx ncc build"
+    "build": "npx tsc && npx ncc build",
+    "format": "prettier --write '**/*.ts'",
+    "format-check": "prettier --check '**/*.ts'",
+    "lint": "eslint src/**/*.ts"
   },
   "author": "",
   "license": "MIT",

packages/docker/src/dockerCommands/container.ts

@@ -43,11 +43,16 @@ export async function createContainer(
 
   if (args.environmentVariables) {
     for (const [key] of Object.entries(args.environmentVariables)) {
-      dockerArgs.push('-e')
-      dockerArgs.push(key)
+      dockerArgs.push('-e', key)
     }
   }
 
+  dockerArgs.push('-e', 'GITHUB_ACTIONS=true')
+  // Use same behavior as the runner https://github.com/actions/runner/blob/27d9c886ab9a45e0013cb462529ac85d581f8c41/src/Runner.Worker/Container/DockerCommandManager.cs#L150
+  if (!('CI' in (args.environmentVariables ?? {}))) {
+    dockerArgs.push('-e', 'CI=true')
+  }
+
   const mountVolumes = [
     ...(args.userMountVolumes || []),
     ...(args.systemMountVolumes || [])
@@ -403,11 +408,16 @@ export async function containerRun(
   }
   if (args.environmentVariables) {
     for (const [key] of Object.entries(args.environmentVariables)) {
-      dockerArgs.push('-e')
-      dockerArgs.push(key)
+      dockerArgs.push('-e', key)
     }
   }
 
+  dockerArgs.push('-e', 'GITHUB_ACTIONS=true')
+  // Use same behavior as the runner https://github.com/actions/runner/blob/27d9c886ab9a45e0013cb462529ac85d581f8c41/src/Runner.Worker/Container/DockerCommandManager.cs#L150
+  if (!('CI' in (args.environmentVariables ?? {}))) {
+    dockerArgs.push('-e', 'CI=true')
+  }
+
   const mountVolumes = [
     ...(args.userMountVolumes || []),
     ...(args.systemMountVolumes || [])

packages/docker/tests/run-script-step-test.ts

@@ -75,4 +75,22 @@ describe('run script step', () => {
       runScriptStep(definitions.runScriptStep.args, prepareJobResponse.state)
     ).resolves.not.toThrow()
   })
+
+  it('Should confirm that CI and GITHUB_ACTIONS are set', async () => {
+    definitions.runScriptStep.args.entryPoint = '/bin/bash'
+    definitions.runScriptStep.args.entryPointArgs = [
+      '-c',
+      `'if [[ ! $(env | grep "^CI=") = "CI=true" ]]; then exit 1; fi'`
+    ]
+    await expect(
+      runScriptStep(definitions.runScriptStep.args, prepareJobResponse.state)
+    ).resolves.not.toThrow()
+    definitions.runScriptStep.args.entryPointArgs = [
+      '-c',
+      `'if [[ ! $(env | grep "^GITHUB_ACTIONS=") = "GITHUB_ACTIONS=true" ]]; then exit 1; fi'`
+    ]
+    await expect(
+      runScriptStep(definitions.runScriptStep.args, prepareJobResponse.state)
+    ).resolves.not.toThrow()
+  })
 })

packages/k8s/src/hooks/prepare-job.ts

@@ -229,6 +229,18 @@ export function createContainerSpec(
     }
   }
 
+  podContainer.env.push({
+    name: 'GITHUB_ACTIONS',
+    value: 'true'
+  })
+
+  if (!('CI' in container['environmentVariables'])) {
+    podContainer.env.push({
+      name: 'CI',
+      value: 'true'
+    })
+  }
+
   podContainer.volumeMounts = containerVolumes(
     container.userMountVolumes,
     jobContainer

packages/k8s/src/hooks/run-container-step.ts

@@ -29,7 +29,14 @@ export async function runContainerStep(
   let secretName: string | undefined = undefined
   if (stepContainer.environmentVariables) {
     try {
-      secretName = await createSecretForEnvs(stepContainer.environmentVariables)
+      const envs = JSON.parse(
+        JSON.stringify(stepContainer.environmentVariables)
+      )
+      envs['GITHUB_ACTIONS'] = 'true'
+      if (!('CI' in envs)) {
+        envs.CI = 'true'
+      }
+      secretName = await createSecretForEnvs(envs)
     } catch (err) {
       core.debug(`createSecretForEnvs failed: ${JSON.stringify(err)}`)
       const message = (err as any)?.response?.body?.message || err

packages/k8s/tests/k8s-utils-test.ts

@@ -394,7 +394,7 @@ metadata:
 spec:
   containers:
     - name: test
-      image: node:14.16
+      image: node:22
     - name: job
       image: ubuntu:latest`
       )
@@ -407,7 +407,7 @@ spec:
 
   it('should merge container spec', () => {
     const base = {
-      image: 'node:14.16',
+      image: 'node:22',
       name: 'test',
       env: [
         {
@@ -462,7 +462,7 @@ spec:
     const base = {
       containers: [
         {
-          image: 'node:14.16',
+          image: 'node:22',
           name: 'test',
           env: [
             {

packages/k8s/tests/prepare-job-test.ts

@@ -62,6 +62,54 @@ describe('Prepare job', () => {
     ).resolves.not.toThrow()
   })
 
+  it('should prepare job with envs CI and GITHUB_ACTIONS', async () => {
+    await prepareJob(prepareJobData.args, prepareJobOutputFilePath)
+
+    const content = JSON.parse(
+      fs.readFileSync(prepareJobOutputFilePath).toString()
+    )
+
+    const got = await getPodByName(content.state.jobPod)
+    expect(got.spec?.containers[0].env).toEqual(
+      expect.arrayContaining([
+        { name: 'CI', value: 'true' },
+        { name: 'GITHUB_ACTIONS', value: 'true' }
+      ])
+    )
+    expect(got.spec?.containers[1].env).toEqual(
+      expect.arrayContaining([
+        { name: 'CI', value: 'true' },
+        { name: 'GITHUB_ACTIONS', value: 'true' }
+      ])
+    )
+  })
+
+  it('should not override CI env var if already set', async () => {
+    prepareJobData.args.container.environmentVariables = {
+      CI: 'false'
+    }
+
+    await prepareJob(prepareJobData.args, prepareJobOutputFilePath)
+
+    const content = JSON.parse(
+      fs.readFileSync(prepareJobOutputFilePath).toString()
+    )
+
+    const got = await getPodByName(content.state.jobPod)
+    expect(got.spec?.containers[0].env).toEqual(
+      expect.arrayContaining([
+        { name: 'CI', value: 'false' },
+        { name: 'GITHUB_ACTIONS', value: 'true' }
+      ])
+    )
+    expect(got.spec?.containers[1].env).toEqual(
+      expect.arrayContaining([
+        { name: 'CI', value: 'true' },
+        { name: 'GITHUB_ACTIONS', value: 'true' }
+      ])
+    )
+  })
+
   it('should throw an exception if the user volume mount is absolute path outside of GITHUB_WORKSPACE', async () => {
     prepareJobData.args.container.userMountVolumes = [
       {
@@ -125,7 +173,7 @@ describe('Prepare job', () => {
 
     // job container
     expect(got.spec?.containers[0].name).toBe(JOB_CONTAINER_NAME)
-    expect(got.spec?.containers[0].image).toBe('node:14.16')
+    expect(got.spec?.containers[0].image).toBe('node:22')
     expect(got.spec?.containers[0].command).toEqual(['sh'])
     expect(got.spec?.containers[0].args).toEqual(['-c', 'sleep 50'])
 
@@ -133,9 +181,13 @@ describe('Prepare job', () => {
     expect(got.spec?.containers[1].image).toBe('redis')
     expect(got.spec?.containers[1].command).toBeFalsy()
     expect(got.spec?.containers[1].args).toBeFalsy()
-    expect(got.spec?.containers[1].env).toEqual([
-      { name: 'ENV2', value: 'value2' }
-    ])
+    expect(got.spec?.containers[1].env).toEqual(
+      expect.arrayContaining([
+        { name: 'CI', value: 'true' },
+        { name: 'GITHUB_ACTIONS', value: 'true' },
+        { name: 'ENV2', value: 'value2' }
+      ])
+    )
     expect(got.spec?.containers[1].resources).toEqual({
       requests: { memory: '1Mi', cpu: '1' },
       limits: { memory: '1Gi', cpu: '2' }

packages/k8s/tests/run-container-step-test.ts

@@ -78,4 +78,15 @@ describe('Run container step', () => {
       runContainerStep(runContainerStepData.args)
     ).resolves.not.toThrow()
   })
+
+  it('should run container step with envs CI and GITHUB_ACTIONS', async () => {
+    runContainerStepData.args.entryPoint = 'bash'
+    runContainerStepData.args.entryPointArgs = [
+      '-c',
+      "'if [[ -z $GITHUB_ACTIONS  ]] || [[ -z $CI ]]; then exit 1; fi'"
+    ]
+    await expect(
+      runContainerStep(runContainerStepData.args)
+    ).resolves.not.toThrow()
+  })
 })

releaseNotes.md

@@ -1,10 +1,24 @@
-<!-- ## Features -->
+## Features
 
-<!-- ## Bugs -->
+- k8s: Use pod affinity when KubeScheduler is enabled [#212]
+- docker: support alternative network modes [#209]
+
+## Bugs
+
+- Expose CI=true and GITHUB_ACTIONS env variables [#215]
+- k8s: add /github/home to containerAction mounts and surface createSecretForEnvs errors [#198]
+- k8s: start logging from the beginning [#184]
 
 ## Misc
 
-- Bump `@kubernetes/client-node` from 0.18.1 to 0.22.0 in /packages/k8s [#182]
+- Bump node in tests to node 22 since node14 is quite old [#216]
+- Bump jsonpath-plus from 10.1.0 to 10.3.0 in /packages/k8s [#213]
+- Bump braces from 3.0.2 to 3.0.3 in /packages/hooklib [#194]
+- Bump cross-spawn from 7.0.3 to 7.0.6 in /packages/k8s [#196]
+- Bump ws from 7.5.8 to 7.5.10 in /packages/k8s [#192]
+- Remove dependency on deprecated release actions [#193]
+- Update to the latest available actions [#191]
+
 
 ## SHA-256 Checksums