Skip to content
This repository was archived by the owner on Oct 3, 2025. It is now read-only.

Commit 9e1d7ed

Browse files
authored
docs: update CONTRIBUTING.md with new release flow (#1089)
1 parent c9df719 commit 9e1d7ed

File tree

3 files changed

+13
-15
lines changed

3 files changed

+13
-15
lines changed

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
## 14.0.0-beta.3
1+
## 14.0.0-beta.4
22

3+
- Updated documentation regarding release flow, which now
4+
requires manual update of version and changelog.
35
- Fixed player non-relative imports from within the package.
46
- Fixed next/latest tag selection in publish workflow.
57

CONTRIBUTING.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ There are two sets of examples: those that expect a camera backend,
4747
and those that work with a test video provided by an RTSP server that
4848
you can run locally via this library.
4949

50-
Run `just run [workspace]` to build the library, run a local RTSP test server, and serve
50+
Run `just run [example]` to build the library, run a local RTSP test server, and serve
5151
the examples. You'll see a link to a port on `localhost` (usually 8080).
5252

5353
## Creating PRs
@@ -56,6 +56,11 @@ Whenever you want to apply your changes to the upstream repository,
5656
you can create a pull request (PR). You can find general information
5757
on making pull requests on GitHub.
5858

59+
Each PR has to have an updated `package.json` version (with a semver
60+
matching the kind of change), and an entry in the `CHANGELOG.md` file.
61+
The latter only needs to contain the latest version at the top (it's
62+
ok to combine logs for non-release changes).
63+
5964
## Continuous integration
6065

6166
### Verification
@@ -66,15 +71,6 @@ These tests always need to pass before a PR can be merged.
6671

6772
### Releases
6873

69-
When tags are pushed, an automated deploy will release to both Github and NPM, which
70-
can be found in `.github/workflows/publish.yml`.
71-
Any tags that are prereleases will be tagged `next` for NPM, otherwise `latest` is used.
72-
73-
To release, make sure you are on the `main` branch and run:
74-
75-
```
76-
just release
77-
git push --follow-tags
78-
```
79-
80-
after which the pushed tag will cause a build + deploy through GitHub Actions.
74+
To publish a new release (and deploy a new NPM package), trigger the "Publish" workflow
75+
in the GitHub actions tab. This will create a GitHub release (from the version in the
76+
`package.json` file), tag the commit, and deploy a new package to NPM.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "media-stream-library",
3-
"version": "14.0.0-beta.3",
3+
"version": "14.0.0-beta.4",
44
"description": "Media libraries for Node and the Web.",
55
"repository": {
66
"type": "git",

0 commit comments

Comments
 (0)