Skip to content

Commit

Permalink
Adding some release documentation for my own reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Yahweasel committed Sep 28, 2024
1 parent d87092b commit 46423e3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
These are notes, mainly to myself, for making a release.

* The versioning scheme is `my major.my minor.ffmpeg version`. So, e.g., my own
3.1 with FFmpeg 4.1.5 is `3.1.4.1.5`. NPM only supports three parts, so that
becomes `3.1.4`.

* Before making a release, run the tests with coverage. I don't presently try
to make sure that the tests actually have perfect coverage, but it's at least
a good way to know what I'm missing.

* Check library versions. Anything but FFmpeg is usually trivial to update, so
can be updated shortly before release.

* Run `tools/fragment-sizes.sh`.

* When updating the version, follow the instructions in package.json.

* Make a release with `make release`, then publish it to NPM with `make
npm-publish`. Publish the tarball to github.

0 comments on commit 46423e3

Please sign in to comment.