feat: differentiate GitHub Actions environments in user-agent

workspaces/config/lib/definitions/definitions.js

@@ -2476,7 +2476,25 @@ const definitions = {
     `,
     flatten (key, obj, flatOptions) {
       const value = obj[key]
-      const ciName = ciInfo.name?.toLowerCase().split(' ').join('-') || null
+      let ciName = ciInfo.name?.toLowerCase().split(' ').join('-') || null
+      if (ciInfo.GITHUB_ACTIONS) {
+        // Env vars can be absent, empty, or whitespace; normalize before use.
+        const serverUrl = (process.env.GITHUB_SERVER_URL || '').trim()
+        const runnerEnv = (process.env.RUNNER_ENVIRONMENT || '').trim()
+        if (serverUrl === 'https://github.com') {
+          if (runnerEnv === 'github-hosted') {
+            ciName = 'github-actions-dotcom-hosted'
+          } else if (runnerEnv === 'self-hosted') {
+            ciName = 'github-actions-dotcom-selfhosted'
+          } else {
+            ciName = 'github-actions-dotcom'
+          }
+        } else if (serverUrl.endsWith('.ghe.com')) {
+          ciName = 'github-actions-ghecom'
+        } else if (serverUrl) {
+          ciName = 'github-actions-ghes'
+        }
+      }
       let inWorkspaces = false
       if (obj.workspaces || obj.workspace && obj.workspace.length) {
         inWorkspaces = true

workspaces/config/test/definitions/definitions.js

@@ -860,6 +860,94 @@ t.test('user-agent', t => {
   t.end()
 })
 
+t.test('user-agent github actions ci variants', t => {
+  const npmVersion = '1.2.3'
+  const base = `npm/${npmVersion} node/${process.version} ` +
+    `${process.platform} ${process.arch} workspaces/false`
+
+  const cases = [
+    {
+      name: 'dotcom + github-hosted runner',
+      env: { GITHUB_SERVER_URL: 'https://github.com', RUNNER_ENVIRONMENT: 'github-hosted' },
+      expect: `${base} ci/github-actions-dotcom-hosted`,
+    },
+    {
+      name: 'dotcom + self-hosted runner',
+      env: { GITHUB_SERVER_URL: 'https://github.com', RUNNER_ENVIRONMENT: 'self-hosted' },
+      expect: `${base} ci/github-actions-dotcom-selfhosted`,
+    },
+    {
+      name: 'dotcom + missing runner environment',
+      env: { GITHUB_SERVER_URL: 'https://github.com', RUNNER_ENVIRONMENT: undefined },
+      expect: `${base} ci/github-actions-dotcom`,
+    },
+    {
+      name: 'dotcom + whitespace runner environment',
+      env: { GITHUB_SERVER_URL: 'https://github.com', RUNNER_ENVIRONMENT: '   ' },
+      expect: `${base} ci/github-actions-dotcom`,
+    },
+    {
+      name: 'ghe.com tenant',
+      env: { GITHUB_SERVER_URL: 'https://octocorp.ghe.com', RUNNER_ENVIRONMENT: 'github-hosted' },
+      expect: `${base} ci/github-actions-ghecom`,
+    },
+    {
+      name: 'ghes (non-empty, non github.com, non ghe.com)',
+      env: { GITHUB_SERVER_URL: 'https://github.example.com', RUNNER_ENVIRONMENT: 'self-hosted' },
+      expect: `${base} ci/github-actions-ghes`,
+    },
+    {
+      name: 'missing server url stays generic',
+      env: { GITHUB_SERVER_URL: undefined, RUNNER_ENVIRONMENT: undefined },
+      expect: `${base} ci/github-actions`,
+    },
+    {
+      name: 'whitespace server url stays generic',
+      env: { GITHUB_SERVER_URL: '   ', RUNNER_ENVIRONMENT: 'github-hosted' },
+      expect: `${base} ci/github-actions`,
+    },
+  ]
+
+  for (const { name, env, expect } of cases) {
+    t.test(name, t => {
+      mockGlobals(t, { 'process.env': env })
+      const obj = {
+        'npm-version': npmVersion,
+        'user-agent': mockDefs({
+          'ci-info': { isCi: true, name: 'GitHub Actions', GITHUB_ACTIONS: true },
+        })['user-agent'].default,
+      }
+      const flat = {}
+      mockDefs({
+        'ci-info': { isCi: true, name: 'GitHub Actions', GITHUB_ACTIONS: true },
+      })['user-agent'].flatten('user-agent', obj, flat)
+      t.equal(flat.userAgent, expect)
+      t.equal(process.env.npm_config_user_agent, flat.userAgent, 'npm_user_config environment is set')
+      t.end()
+    })
+  }
+
+  t.test('non github-actions ci is unchanged', t => {
+    mockGlobals(t, {
+      'process.env': { GITHUB_SERVER_URL: 'https://github.com', RUNNER_ENVIRONMENT: 'github-hosted' },
+    })
+    const obj = {
+      'npm-version': npmVersion,
+      'user-agent': mockDefs({
+        'ci-info': { isCi: true, name: 'Travis CI', GITHUB_ACTIONS: false },
+      })['user-agent'].default,
+    }
+    const flat = {}
+    mockDefs({
+      'ci-info': { isCi: true, name: 'Travis CI', GITHUB_ACTIONS: false },
+    })['user-agent'].flatten('user-agent', obj, flat)
+    t.equal(flat.userAgent, `${base} ci/travis-ci`)
+    t.end()
+  })
+
+  t.end()
+})
+
 t.test('save-prefix', t => {
   const obj = {
     'save-exact': true,