Skip to content

Commit bb0dd8d

Browse files
committed
Changed: docs/installation.md to describe different package versions
1 parent e2e3560 commit bb0dd8d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/installation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ An unstable 2.x version of this package with breaking changes is under developme
1818

1919
Until a 2.0 version is officially released, it can be installed from https://github.com/IQSS/dataverse-client-javascript/pkgs/npm/dataverse-client-javascript
2020

21+
Two different versions are being pushed to the GitHub Packages registry:
22+
23+
1. **PR-Generated Versions**:
24+
25+
- These versions are generated from pull request commits.
26+
- They follow the structure `2.0.0-pr<pr_number>.<commit_hash>`, where `pr_number` is the number of the pull request, and `commit_hash` is the specific commit hash from the PR branch.
27+
- These versions are unstable and correspond to the state of the package during the pull request.
28+
29+
2. **Develop Alpha Versions**:
30+
- These versions are generated on every commit made to the `develop` branch, ideally after each pull request is merged.
31+
- They follow the structure `2.0.0-alpha.<number>`, where `number` is an incremental value that starts at 1 and increases with each build.
32+
- These versions are also unstable and represent the latest work in progress on the `develop` branch.
33+
2134
### Create a `.npmrc` file and add a token
2235

2336
To install the [@iqss/dataverse-client-javascript](https://github.com/IQSS/dataverse-client-javascript/pkgs/npm/dataverse-client-javascript)

0 commit comments

Comments
 (0)