chore: improve packaging flow

.github/workflows/publish.yml

@@ -58,7 +58,7 @@ jobs:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
         run: |
           if [[ $GITHUB_REF =~ alpha|beta ]]; then
-              npm publish --tag next
+              yarn npm publish --tag next
           else
-              npm publish --tag latest
+              yarn npm publish --tag latest
           fi

.yarn/versions/4a7e75d5.yml

@@ -0,0 +1,2 @@
+releases:
+  media-stream-library: major

.yarnrc.yml

@@ -1,9 +1,13 @@
-yarnPath: '.yarn/releases/yarn-berry.cjs'
-
 packageExtensions:
   readable-stream@*:
     dependencies:
-      events: '*'
+      events: "*"
   stream-browserify@*:
     dependencies:
-      events: '*'
+      events: "*"
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
+    spec: "@yarnpkg/plugin-version"
+
+yarnPath: .yarn/releases/yarn-berry.cjs

CONTRIBUTING.md

@@ -49,6 +49,26 @@ you can run locally via this library.
 Run `yarn dev` 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
+
+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.
+
+When you are ready to push your changes,
+make sure you include a proper version strategy in your commit by running:
+
+```
+yarn version <strategy> --deferred
+```
+
+where you should select a `<strategy>` based on if your changes introduce
+(possible) breaking changes (`major`), new feature additions (`minor`),
+or just fixes a bug (`patch`).
+
+The command will generate a file in `.yarn/versions` that should be committed
+together with your changes.
+
 ## Continuous integration
 
 ### Verification

package.json

@@ -10,6 +10,14 @@
   "bin": {
     "live": "examples/node/player.js"
   },
+  "files": [
+    "dist/**/*",
+    "examples/**/*",
+    "rtsp-ws-server/*",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
   "scripts": {
     "lint": "yarn eslint && yarn prettier:check",
     "test": "jest --coverage",
@@ -25,8 +33,7 @@
     "rtsp": "rtsp-ws-server/start.sh",
     "examples": "http-server examples/browser",
     "dev": "node sbin/dev.js",
-    "version": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
-    "release": "yarn version --new-version `node node_modules/.bin/conventional-recommended-bump -p angular`"
+    "release": "sbin/release.sh"
   },
   "repository": {
     "type": "git",
@@ -59,9 +66,6 @@
     "@typescript-eslint/eslint-plugin": "4.3.0",
     "@typescript-eslint/parser": "4.3.0",
     "babel-loader": "8.1.0",
-    "concurrently": "5.3.0",
-    "conventional-changelog-cli": "2.1.1",
-    "conventional-recommended-bump": "6.0.11",
     "core-js": "3.6.5",
     "cypress": "5.5.0",
     "eslint": "7.12.1",
@@ -73,6 +77,7 @@
     "jest": "26.4.2",
     "mock-socket": "9.0.3",
     "prettier": "2.1.2",
+    "semver": "7.3.2",
     "ts-jest": "26.4.3",
     "typescript": "4.0.5",
     "webpack": "5.4.0",

sbin/release.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # Generate new commit
-if [[ ! -d .yarn/version ]]; then
+if [[ ! -d .yarn/versions ]]; then
   yarn version patch
 fi
 yarn version apply --all