Skip to content

Commit

Permalink
docs: add alpha approach to test (#507)
Browse files Browse the repository at this point in the history
  • Loading branch information
tassioFront authored Jul 31, 2024
1 parent 20bc601 commit fdeba1e
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 2 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,26 @@ To enable syntax highlighting in your editor, you need to install the following

- [lit-html](https://marketplace.visualstudio.com/items?itemName=bierner.lit-html)

## Local test using Alpha/Beta versions

To locally test Atomium using Alpha/Beta versions, follow the steps below:

1. Update the `.release-please-manifest.json` file in the root directory of the Atomium project with the next version number + alpha. Ex: the current version is `2.10.0`, so the next alpha version can be `2.11.0-alpha.1` (OBS: in the example, it is updating only the core lib, update the libs that your changes impact).

![image](./utils/doc-images/add-alpha-version-to-release-json.png)

2. Add the same version to the repespective `package.json` file in the root directory of the lib project. Ex: packages/core/package.json

![image](./utils/doc-images/add-alpha-to-package-json.png)

3. Build the Atomium libraries by running the following command in the root directory of the Atomium project

```bash
npx nx run @juntossomosmais/atomium:publish-library-alpha
```

OBS: you can even share the alpha version with your team, than they can test it locally.

## Local test using NPM Link

To locally test Atomium using NPM Link, follow the steps below:
Expand Down
3 changes: 2 additions & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"test:watch": "stencil test --spec",
"generate": "stencil generate",
"prebuild": "npx mkdirp react && npx mkdirp vue && cd > core.css",
"publish-library": "npm publish --access public"
"publish-library": "npm publish --access public",
"publish-library-alpha": "npm publish --access public --tag alpha"
},
"nx": {
"targets": {
Expand Down
3 changes: 2 additions & 1 deletion packages/tokens/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
"build": "ts-node ./scripts/generate-tokens/index.ts && rollup -c rollup.tokens.config.mjs && tsc --module commonjs",
"publish-library": "npm publish --access public",
"test:ci": "jest --coverage --no-cache --updateSnapshot --ci",
"test": "jest"
"test": "jest",
"publish-library-alpha": "npm publish --access public --tag alpha"
},
"files": [
"dist"
Expand Down
Binary file added utils/doc-images/add-alpha-to-package-json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fdeba1e

Please sign in to comment.