@ember-finance/sdk 2.10.3 → 2.10.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -475,6 +475,22 @@ Note: Standard ERC-4626 `withdraw` and `redeem` are not supported due to the vau
|
|
|
475
475
|
withdrawal mechanism. Use `redeemShares` to initiate a withdrawal request, which will be
|
|
476
476
|
processed by vault operators.
|
|
477
477
|
|
|
478
|
+
## Releasing
|
|
479
|
+
|
|
480
|
+
`@ember-finance/sdk` is published by `.github/workflows/publish_to_npm.yaml` using npm
|
|
481
|
+
OIDC trusted publishing. There is no npm token — npm authorises that one workflow file by
|
|
482
|
+
exact filename, so all three publish paths live in it and the file must not be renamed.
|
|
483
|
+
|
|
484
|
+
| Intent | Action | dist-tag |
|
|
485
|
+
| --------------- | ----------------------------------- | ------------- |
|
|
486
|
+
| Release | Push (merge) to `main` | `latest` |
|
|
487
|
+
| Pre-release | Push tag `pre-release-<version>` | `pre-release` |
|
|
488
|
+
| Retry a publish | Run the workflow, pick a `dist_tag` | chosen |
|
|
489
|
+
|
|
490
|
+
Bump `version` in `package.json` in the PR. npm versions are immutable, so the workflow
|
|
491
|
+
fails early if that version is already published; to retry a failed publish, dispatch the
|
|
492
|
+
workflow rather than pushing another tag.
|
|
493
|
+
|
|
478
494
|
## License
|
|
479
495
|
|
|
480
496
|
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file
|