-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #157 from ecadlabs/pr-packages-docs
chore: added pull request packages documentation
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/[email protected]` | | ||
| `npm install @taqueria/[email protected]` | | ||
| `npm install @taqueria/[email protected]` | | ||
| `npm install @taqueria/[email protected]` | | ||
|
||
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` |