@opentelemetry/resource-detector-github - npm Package Compare versions

Comparing version 0.28.1 to 0.28.2

build/src/detectors/GitHubDetector.d.ts

@@ -25,3 +25,3 @@ import { Detector, Resource } from '@opentelemetry/resources';
      *
-     * If succesful it returns a promise containing a {@link Resource}
+     * If successful it returns a promise containing a {@link Resource}
      * populated with GitHub metadata. Returns a promise containing an
@@ -28,0 +28,0 @@ * empty {@link Resource} if the connection fails.

build/src/detectors/GitHubDetector.js

@@ -49,3 +49,3 @@ "use strict";
      *
-     * If succesful it returns a promise containing a {@link Resource}
+     * If successful it returns a promise containing a {@link Resource}
      * populated with GitHub metadata. Returns a promise containing an
@@ -52,0 +52,0 @@ * empty {@link Resource} if the connection fails.

package.json

 {
   "name": "@opentelemetry/resource-detector-github",
-  "version": "0.28.1",
+  "version": "0.28.2",
   "description": "OpenTelemetry SDK resource detector for GitHub",
@@ -15,3 +15,3 @@ "main": "build/src/index.js",
     "prewatch": "npm run precompile",
-    "prepare": "npm run compile",
+    "prepublishOnly": "npm run compile",
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
@@ -37,6 +37,3 @@ "tdd": "npm run test -- --watch-extensions ts --watch",
     "build/src/**/*.js.map",
-    "build/src/**/*.d.ts",
-    "doc",
-    "LICENSE",
-    "README.md"
+    "build/src/**/*.d.ts"
   ],
@@ -52,8 +49,8 @@ "publishConfig": {
     "@types/mocha": "8.2.3",
-    "@types/node": "18.16.19",
-    "@types/sinon": "10.0.16",
+    "@types/node": "18.6.5",
+    "@types/sinon": "10.0.18",
     "mocha": "7.2.0",
     "nyc": "15.1.0",
-    "rimraf": "5.0.1",
-    "sinon": "15.0.1",
+    "rimraf": "5.0.5",
+    "sinon": "15.2.0",
     "ts-mocha": "10.0.0",
@@ -66,3 +63,3 @@ "typescript": "4.4.4"
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-github#readme",
-  "gitHead": "b3d30afe7376760d211b20c4fb45988ac58c1d85"
+  "gitHead": "96a87b48934f0afcf1fe637eed6704f35bd8e973"
 }

README.md

@@ -36,5 +36,20 @@ # OpenTelemetry Resource Detector for GitHub Actions
 
+## Available detectors
+
+### GitHub Detector
+
+| Resource Attribute | Description                                               |
+|--------------------|-----------------------------------------------------------|
+| github.actor       | Value of Process Environment Variable `GITHUB_ACTOR`      |
+| github.base_ref    | Value of Process Environment Variable `GITHUB_BASE_REF`   |
+| github.head_ref    | Value of Process Environment Variable `GITHUB_HEAD_REF`   |
+| github.ref         | Value of Process Environment Variable `GITHUB_REF`        |
+| github.run_id      | Value of Process Environment Variable `GITHUB_RUN_ID`     |
+| github.run_number  | Value of Process Environment Variable `GITHUB_RUN_NUMBER` |
+| github.sha         | Value of Process Environment Variable `GITHUB_SHA`        |
+| github.workflow    | Value of Process Environment Variable `GITHUB_WORKFLOW`   |
+
 ## Useful links
 
-- [GitHub Action Enviornment Variables](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables)
+- [GitHub Action Environment Variables](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables)
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
@@ -41,0 +56,0 @@ - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>

No alert changes

Improved metrics

Total package byte prevSize

28654

increased by3.04%

Number of lines in readme file

67

increased by28.85%

No dependency changes