Merge pull request #94 from check-run-reporter/user-agent

user agent

integrations/action/README.md

@@ -48,7 +48,6 @@ jobs:
                 node-version: '12.x'
             - run: npm ci
             - run: npm test
-              # Please replace "master" with the latest git tag
             - uses: check-run-reporter/action@v0.0.0
               # always run, otherwise you'll only see results for passing builds
               if: ${{ always() }}

scripts/get-action-version

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 /**
- * @file This file produces new version for the buildkite plugin based on the
- * repo versoin. The buildkite plugin was already at version 1 when this repo
+ * @file This file produces new version for the action plugin based on the
+ * repo version. The buildkite plugin was already at version 1 when this repo
  * was created.
  */
 

scripts/get-buildkite-version

@@ -2,7 +2,7 @@
 
 /**
  * @file This file produces new version for the buildkite plugin based on the
- * repo versoin. The buildkite plugin was already at version 1 when this repo
+ * repo version. The buildkite plugin was already at version 1 when this repo
  * was created.
  */
 

src/commands/split.ts

@@ -1,13 +1,11 @@
 import util from 'util';
 
 import axios from 'axios';
-import axiosRetry from 'axios-retry';
 
+import {client} from '../lib/axios';
 import {multiGlob} from '../lib/file';
 import {Context} from '../lib/types';
 
-axiosRetry(axios, {retries: 3});
-
 interface SplitArgs {
   /** list of filenames or globs that match all available test files */
   readonly tests: readonly string[];
@@ -71,7 +69,7 @@ export async function split(
     logger.info(`Tests: ${filenames}`);
     logger.debug(`URL: ${url}`);
 
-    const response = await axios.post(url, params, {
+    const response = await client.post(url, params, {
       auth: {password: token, username: 'token'},
     });
 

src/commands/submit.ts

@@ -1,14 +1,12 @@
 import fs from 'fs';
 import util from 'util';
 
-import axios from 'axios';
 import FormData from 'form-data';
-import axiosRetry from 'axios-retry';
+import axios from 'axios';
 
 import {multiGlob} from '../lib/file';
 import {Context} from '../lib/types';
-
-axiosRetry(axios, {retries: 3});
+import {client} from '../lib/axios';
 
 type Optional<T> = T | undefined;
 
@@ -50,7 +48,7 @@ export async function submit(
     logger.info(`SHA: ${sha}`);
     logger.debug(`URL: ${url}`);
 
-    const response = await axios.post(url, formData, {
+    const response = await client.post(url, formData, {
       auth: {password: token, username: 'token'},
       headers: {
         ...formData.getHeaders(),

src/lib/axios.ts

@@ -0,0 +1,16 @@
+import axiosRetry from 'axios-retry';
+import axios from 'axios';
+import ci from 'ci-info';
+
+import pkg from '../../package.json';
+
+const {version} = pkg;
+
+const prInfo = typeof ci.isPR === 'boolean' ? `(PR: ${ci.isPR})` : '';
+
+export const client = axios.create({
+  headers: {
+    'user-agent': `crr/${version} ${ci.name} ${prInfo}`,
+  },
+});
+axiosRetry(client, {retries: 3});