diff --git a/README.md b/README.md index 1219cd64b..bfbbad473 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/packages/core/package.json b/packages/core/package.json index c79dfe4ff..e27819dc3 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -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": { diff --git a/packages/tokens/package.json b/packages/tokens/package.json index d9f54081d..c364c991a 100644 --- a/packages/tokens/package.json +++ b/packages/tokens/package.json @@ -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" diff --git a/utils/doc-images/add-alpha-to-package-json.png b/utils/doc-images/add-alpha-to-package-json.png new file mode 100644 index 000000000..7f3126c70 Binary files /dev/null and b/utils/doc-images/add-alpha-to-package-json.png differ diff --git a/utils/doc-images/add-alpha-version-to-release-json.png b/utils/doc-images/add-alpha-version-to-release-json.png new file mode 100644 index 000000000..bcc965ff0 Binary files /dev/null and b/utils/doc-images/add-alpha-version-to-release-json.png differ