Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md with new release flow (#1089)
Browse files Browse the repository at this point in the history
  • Loading branch information
steabert authored Jan 13, 2025
1 parent c9df719 commit 9e1d7ed
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 15 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## 14.0.0-beta.3
## 14.0.0-beta.4

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

Expand Down
22 changes: 9 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ There are two sets of examples: those that expect a camera backend,
and those that work with a test video provided by an RTSP server that
you can run locally via this library.

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

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

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

## Continuous integration

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

### Releases

When tags are pushed, an automated deploy will release to both Github and NPM, which
can be found in `.github/workflows/publish.yml`.
Any tags that are prereleases will be tagged `next` for NPM, otherwise `latest` is used.

To release, make sure you are on the `main` branch and run:

```
just release
git push --follow-tags
```

after which the pushed tag will cause a build + deploy through GitHub Actions.
To publish a new release (and deploy a new NPM package), trigger the "Publish" workflow
in the GitHub actions tab. This will create a GitHub release (from the version in the
`package.json` file), tag the commit, and deploy a new package to NPM.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "media-stream-library",
"version": "14.0.0-beta.3",
"version": "14.0.0-beta.4",
"description": "Media libraries for Node and the Web.",
"repository": {
"type": "git",
Expand Down

0 comments on commit 9e1d7ed

Please sign in to comment.