From 46423e388b038b53234ec23728a075ea99a8ae59 Mon Sep 17 00:00:00 2001 From: Yahweasel Date: Sat, 28 Sep 2024 16:18:46 -0400 Subject: [PATCH] Adding some release documentation for my own reference --- docs/RELEASE.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/RELEASE.md diff --git a/docs/RELEASE.md b/docs/RELEASE.md new file mode 100644 index 00000000..66df7d26 --- /dev/null +++ b/docs/RELEASE.md @@ -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.