diff --git a/website/docs/pull_request_packages.md b/website/docs/pull_request_packages.md new file mode 100644 index 000000000..64546ec94 --- /dev/null +++ b/website/docs/pull_request_packages.md @@ -0,0 +1,22 @@ +--- +title: Pull request packages +--- + +# Pull Request npm packages + +After submitting a pull request to the `main` branch of the Taqueria repository, the CICD will start building and publishing `npm` packages to npmjs.com. The install instructions are then commented on the PR and will look similar to the following: + +| npm package installation instructions | +| ------------------------------------- | +| `npm install @taqueria/plugin-ligo@0.0.0-pr-155-d8b3d05` | +| `npm install @taqueria/plugin-smartpy@0.0.0-pr-155-d8b3d05` | +| `npm install @taqueria/plugin-taquito@0.0.0-pr-155-d8b3d05` | +| `npm install @taqueria/node-sdk@0.0.0-pr-155-d8b3d05` | + +The structure of the package name and version is as follows + +`{package_scope}/{package_name}@0.0.0-pr-{github_pr_number}-{github_commit_short_sha}`. + +All information regarding the pull request and the commit that triggered the build is available in the package version name. The 0.0.0 version number is used because npm packages require a `semver` versioning scheme. + +Each plugin is published to npmjs.com with the `preview` tag and one can install the latest version using `npm install @taqueria/node-sdk@preview` \ No newline at end of file