Skip to content

Commit ffd20ba

Browse files
feat: use npm badges to update package versions in documentation (#4141)
- Remove all automation regarding internally getting the package versions - Replace automation scripts with `npm` badges instead - Add missing `eds-data-grid-react` package to Storybook's `intro.md` file.
1 parent bc98a54 commit ffd20ba

4 files changed

Lines changed: 18 additions & 139 deletions

File tree

apps/design-system-docs/docs/resources/resources.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,19 @@ Find the tools, guides, and assets you need to work effectively with the Equinor
2727

2828
## Available Packages
2929

30-
| Name | Version | npm link | Changelog |
31-
|------|---------|----------|-----------|
32-
| @equinor/eds-core-react | 1.0.1 | [@equinor/eds-core-react](https://www.npmjs.com/package/@equinor/eds-core-react) | [changelog](https://github.com/equinor/design-system/blob/main/packages/eds-core-react/CHANGELOG.md) |
33-
| @equinor/eds-tokens | 1.1.2 | [@equinor/eds-tokens](https://www.npmjs.com/package/@equinor/eds-tokens) | [changelog](https://github.com/equinor/design-system/blob/main/packages/eds-tokens/CHANGELOG.md) |
34-
| @equinor/eds-icons | 1.0.0 | [@equinor/eds-icons](https://www.npmjs.com/package/@equinor/eds-icons) | [changelog](https://github.com/equinor/design-system/blob/main/packages/eds-icons/CHANGELOG.md) |
35-
| @equinor/eds-data-grid-react | 1.0.1 | [@equinor/eds-data-grid-react](https://www.npmjs.com/package/@equinor/eds-data-grid-react) | [changelog](https://github.com/equinor/design-system/blob/main/packages/eds-data-grid-react/CHANGELOG.md) |
36-
| @equinor/eds-utils | 1.0.1 | [@equinor/eds-utils](https://www.npmjs.com/package/@equinor/eds-utils) | [changelog](https://github.com/equinor/design-system/blob/main/packages/eds-utils/CHANGELOG.md) |
37-
| @equinor/eds-lab-react | 0.8.1 | [@equinor/eds-lab-react](https://www.npmjs.com/package/@equinor/eds-lab-react) | [changelog](https://github.com/equinor/design-system/blob/main/packages/eds-lab-react/CHANGELOG.md) |
30+
| Package | Changelog |
31+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
32+
| [![core](https://img.shields.io/npm/v/@equinor/eds-core-react?color=%23c3f3d2&label=%40equinor%2Feds-core-react&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-core-react) | [eds-core-react changelog](https://github.com/equinor/design-system/blob/main/packages/eds-core-react/CHANGELOG.md) |
33+
| [![icons](https://img.shields.io/npm/v/@equinor/eds-icons?color=%23c3f3d2&label=%40equinor%2Feds-icons&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-icons) | [eds-icons changelog](https://github.com/equinor/design-system/blob/main/packages/eds-tokens/CHANGELOG.md) |
34+
| [![tokens](https://img.shields.io/npm/v/@equinor/eds-tokens?color=%23c3f3d2&label=%40equinor%2Feds-tokens&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-tokens) | [eds-tokens changelog](https://github.com/equinor/design-system/blob/main/packages/eds-icons/CHANGELOG.md) |
35+
| [![data-grid](https://img.shields.io/npm/v/@equinor/eds-data-grid-react?color=%23c3f3d2&label=%40equinor%2Feds-data-grid-react&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-data-grid-react) | [eds-data-grid-react changelog](https://github.com/equinor/design-system/blob/main/packages/eds-data-grid-react/CHANGELOG.md) |
36+
| [![lab](https://img.shields.io/npm/v/@equinor/eds-lab-react?color=%23c3f3d2&label=%40equinor%2Feds-lab-react&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-lab-react) | [eds-lab-react changelog](https://github.com/equinor/design-system/blob/main/packages/eds-lab-react/CHANGELOG.md) |
37+
| [![utils](https://img.shields.io/npm/v/@equinor/eds-utils?color=%23c3f3d2&label=%40equinor%2Feds-utils&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-utils) | [eds-utils changelog](https://github.com/equinor/design-system/blob/main/packages/eds-utils/CHANGELOG.md) |
38+
3839
## Versions and Release
3940

4041
Each package follows independent **semantic versioning**.
41-
You can view the latest version in the table above. For our full release notes, please see [Release notes](https://github.com/equinor/design-system/releases).
42+
The latest versions are shown in the badges above, which update automatically from npm. For our full release notes, please see [Release notes](https://github.com/equinor/design-system/releases).
4243

4344
## Need Help?
4445

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"demo:dev": "pnpm --filter eds-demo run dev",
2929
"docu:clear": "pnpm --filter design-system-docs run clear",
3030
"docu:start": "pnpm --filter ./apps/design-system-docs run start",
31-
"docu:build": "node scripts/extract-prerequisites.js && node scripts/extract-package-info.js && pnpm --filter ./apps/design-system-docs run build",
31+
"docu:build": "node scripts/extract-prerequisites.js && pnpm --filter ./apps/design-system-docs run build",
3232
"docu:prerequisites": "node scripts/extract-prerequisites.js",
3333
"docu:serve": "pnpm --filter ./apps/design-system-docs run serve",
3434
"test": "pnpm run test:utils && pnpm run test:core-react && pnpm run test:lab && pnpm run test:data-grid-react",

packages/eds-core-react/stories/docs/Intro.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ import { Typography, List, Card } from '../../src'
3838
- `@equinor/eds-tokens` is a collection our EDS design tokens.
3939

4040

41+
- `@equinor/eds-data-grid-react` provides a data grid component that simplifies tabular data management while following EDS guidelines..
42+
43+
4144
- `@equinor/eds-lab-react` is an experimental package for testing and new upcoming EDS React components.
4245

4346

@@ -48,12 +51,16 @@ import { Typography, List, Card } from '../../src'
4851

4952
[![core](https://img.shields.io/npm/v/@equinor/eds-core-react?color=%23c3f3d2&label=%40equinor%2Feds-core-react&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-core-react)
5053

54+
5155
[![icons](https://img.shields.io/npm/v/@equinor/eds-icons?color=%23c3f3d2&label=%40equinor%2Feds-icons&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-icons)
5256

5357

5458
[![tokens](https://img.shields.io/npm/v/@equinor/eds-tokens?color=%23c3f3d2&label=%40equinor%2Feds-tokens&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-tokens)
5559

5660

61+
[![data-grid](https://img.shields.io/npm/v/@equinor/eds-data-grid-react?color=%23c3f3d2&label=%40equinor%2Feds-data-grid-react&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-data-grid-react)
62+
63+
5764
[![lab](https://img.shields.io/npm/v/@equinor/eds-lab-react?color=%23c3f3d2&label=%40equinor%2Feds-lab-react&logo=npm&)](https://www.npmjs.com/package/@equinor/eds-lab-react)
5865

5966

scripts/extract-package-info.js

Lines changed: 0 additions & 129 deletions
This file was deleted.

0 commit comments

Comments
 (0)