@plasius/video 0.1.1 → 0.1.3
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/CHANGELOG.md +3 -0
- package/README.md +9 -18
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -18,6 +18,9 @@ The format is based on **[Keep a Changelog](https://keepachangelog.com/en/1.1.0/
|
|
|
18
18
|
- Updated CD test stage to execute `npm run test:coverage` and upload coverage to Codecov using OIDC in the release pipeline.
|
|
19
19
|
- Updated Vitest coverage reporters to include `lcov` output for Codecov ingestion.
|
|
20
20
|
- Made SBOM generation non-blocking in CD and only attest when `sbom.cdx.json` is present.
|
|
21
|
+
- Made SBOM release-asset upload non-blocking to avoid failing publish after successful npm release.
|
|
22
|
+
- Updated README badges to include Codecov coverage and point workflow status to `cd.yml`.
|
|
23
|
+
- Normalized README section headings/formatting for consistent markdown rendering.
|
|
21
24
|
|
|
22
25
|
- **Fixed**
|
|
23
26
|
- (placeholder)
|
package/README.md
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
# @plasius/video
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@plasius/video)
|
|
4
|
-
[](https://github.com/Plasius-LTD/video/actions/workflows/cd.yml)
|
|
5
|
+
[](https://codecov.io/gh/Plasius-LTD/video)
|
|
6
|
+
[](./LICENSE)
|
|
6
7
|
[](./CODE_OF_CONDUCT.md)
|
|
7
8
|
[](./SECURITY.md)
|
|
8
9
|
[](./CHANGELOG.md)
|
|
@@ -11,16 +12,12 @@ Video generation components and helpers for the Plasius ecosystem.
|
|
|
11
12
|
|
|
12
13
|
Apache-2.0. ESM + CJS builds. TypeScript types included.
|
|
13
14
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
## Installation
|
|
15
|
+
## Install
|
|
17
16
|
|
|
18
17
|
```bash
|
|
19
18
|
npm install @plasius/video
|
|
20
19
|
```
|
|
21
20
|
|
|
22
|
-
---
|
|
23
|
-
|
|
24
21
|
## Usage
|
|
25
22
|
|
|
26
23
|
```ts
|
|
@@ -29,8 +26,6 @@ import { videoPackageInfo } from "@plasius/video";
|
|
|
29
26
|
console.log(videoPackageInfo.name, videoPackageInfo.version);
|
|
30
27
|
```
|
|
31
28
|
|
|
32
|
-
---
|
|
33
|
-
|
|
34
29
|
## Node.js Version
|
|
35
30
|
|
|
36
31
|
This project uses Node.js **24** by default. The version is pinned in the [`.nvmrc`](./.nvmrc) file.
|
|
@@ -41,14 +36,10 @@ If you use [nvm](https://github.com/nvm-sh/nvm), run:
|
|
|
41
36
|
nvm use
|
|
42
37
|
```
|
|
43
38
|
|
|
44
|
-
---
|
|
45
|
-
|
|
46
39
|
## Package Scope
|
|
47
40
|
|
|
48
41
|
`@plasius/video` is intended to host reusable video generation interfaces and shared view-model logic used across Plasius applications.
|
|
49
42
|
|
|
50
|
-
---
|
|
51
|
-
|
|
52
43
|
## Development
|
|
53
44
|
|
|
54
45
|
```bash
|
|
@@ -58,7 +49,11 @@ npm run test
|
|
|
58
49
|
npm run demo:run
|
|
59
50
|
```
|
|
60
51
|
|
|
61
|
-
|
|
52
|
+
## Demo Sanity Check
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
npm run demo:run
|
|
56
|
+
```
|
|
62
57
|
|
|
63
58
|
## Publishing
|
|
64
59
|
|
|
@@ -68,8 +63,6 @@ This package is published via GitHub CD only.
|
|
|
68
63
|
2. Run `.github/workflows/cd.yml` via **Actions -> CD (Publish to npm) -> Run workflow**.
|
|
69
64
|
3. Select the version bump (`patch`, `minor`, `major`, or `none`) and optional pre-release id.
|
|
70
65
|
|
|
71
|
-
---
|
|
72
|
-
|
|
73
66
|
## Contributing
|
|
74
67
|
|
|
75
68
|
We welcome contributions. See:
|
|
@@ -78,8 +71,6 @@ We welcome contributions. See:
|
|
|
78
71
|
- [Code of Conduct](./CODE_OF_CONDUCT.md)
|
|
79
72
|
- [Contributor License Agreement](./legal/CLA.md)
|
|
80
73
|
|
|
81
|
-
---
|
|
82
|
-
|
|
83
74
|
## License
|
|
84
75
|
|
|
85
76
|
Licensed under the [Apache-2.0 License](./LICENSE).
|