Merge pull request #18 from Bilb/feat/export-versions

chore: add script to generate and upload release

Author: Bilb

Diff for: .github/workflows/test.yml

@@ -52,7 +52,7 @@ jobs:
         if: runner.os == 'Windows'
         shell: bash
         run: |
-          sed -i "s/target_compile_options(oxen-logging-warnings INTERFACE/#target_compile_options(oxen-logging-warnings INTERFACE/" libsession-util/external/oxen-libquic/external/oxen-logging/CMakeLists.txt
+          yarn dirty_sed
           cat libsession-util/external/oxen-libquic/external/oxen-logging/CMakeLists.txt
 
       - name: build libsession-util-nodejs

Diff for: .gitignore

@@ -12,4 +12,4 @@
 .yarn/
 *.cjs
 *.mjs
-
+src/version.ts

Diff for: .prettierignore

@@ -0,0 +1 @@
+src/version.ts

Diff for: README.md

@@ -54,15 +54,7 @@ git commit
 git push upstream main
 # Make sure you do the steps above, otherwise the tag won't be on the right commit with the `gh release create`
 
-virtualenv venv
-source venv/bin/activate
-pip install git-archive-all
-PACKAGE_VERSION=$(cat package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[", ]//g')
-echo $PACKAGE_VERSION
-# NOTE: before you build the archive, below check test.yml for the sed command to apply locally. Will be fixed soon :tm:
-python3 build_release_archive.py libsession_util_nodejs-v$PACKAGE_VERSION.tar.gz
-gh release create v$PACKAGE_VERSION -t v$PACKAGE_VERSION --latest --generate-notes
-gh release upload v$PACKAGE_VERSION libsession_util_nodejs-v$PACKAGE_VERSION.tar.gz
+yarn prepare_release
 ```
 
 And then upload the generated `libsession_util_nodejs-v$PACKAGE_VERSION.tar.gz` to that release just created on github.

Diff for: package.json

@@ -2,15 +2,18 @@
   "main": "index.js",
   "name": "libsession_util_nodejs",
   "description": "Wrappers for the Session Util Library",
-  "version": "0.4.23",
+  "version": "0.4.24",
   "license": "GPL-3.0",
   "author": {
     "name": "Oxen Project",
     "email": "[email protected]"
   },
   "scripts": {
+    "update_version": "sh update_version.sh",
     "clean": "rimraf .cache build",
-    "install": "cmake-js compile --runtime=electron --runtime-version=25.8.4 --CDSUBMODULE_CHECK=OFF --CDLOCAL_MIRROR=https://oxen.rocks/deps --CDENABLE_ONIONREQ=OFF --CDWITH_TESTS=OFF"
+    "install": "cmake-js compile --runtime=electron --runtime-version=25.8.4 --CDSUBMODULE_CHECK=OFF --CDLOCAL_MIRROR=https://oxen.rocks/deps --CDENABLE_ONIONREQ=OFF --CDWITH_TESTS=OFF",
+    "prepare_release": "sh prepare_release.sh",
+    "dirty_sed": "sed -i \"s/target_compile_options(oxen-logging-warnings INTERFACE/#target_compile_options(oxen-logging-warnings INTERFACE/\" libsession-util/external/oxen-libquic/external/oxen-logging/CMakeLists.txt"
   },
   "devDependencies": {
     "clang-format": "^1.8.0",

Diff for: prepare_release.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+set -e
+# set -x
+
+read_char() {
+  stty -icanon -echo
+  eval "$1=\$(dd bs=1 count=1 2>/dev/null)"
+  stty icanon echo
+}
+
+
+rm -f ./libsession_util_nodejs*.tar.gz
+virtualenv venv
+. venv/bin/activate
+pip install git-archive-all
+PACKAGE_VERSION=$(node -p "require('./package.json').version")
+yarn update_version
+echo "PACKAGE_VERSION: $PACKAGE_VERSION"
+echo "Is '$PACKAGE_VERSION' the correct version? If yes, press 'y' to create the release. Press anything else to exit."
+read_char char_read
+case "$char_read" in
+    y) break ;;
+    *) echo "Exiting..."; exit 1 ;;
+esac
+
+
+echo "Continuing..."
+# see test.yml for explanation of this sed command
+yarn dirty_sed
+
+echo "Building tar archive of source..."
+python3 build_release_archive.py libsession_util_nodejs-v$PACKAGE_VERSION.tar.gz
+echo "tar archive size:"
+du -sh libsession_util_nodejs*.tar.gz
+
+echo "Creating draft release on github $PACKAGE_VERSION..."
+GH_RELEASE_URL=$(gh release create v$PACKAGE_VERSION -t v$PACKAGE_VERSION --draft --latest --generate-notes)
+echo "Uploading tar archive to release $PACKAGE_VERSION..."
+gh release upload v$PACKAGE_VERSION libsession_util_nodejs-v$PACKAGE_VERSION.tar.gz
+echo "GH_RELEASE_URL: $GH_RELEASE_URL"
+echo "Done"

Diff for: src/constants.cpp

@@ -3,6 +3,7 @@
 #include "session/config/contacts.hpp"
 #include "session/config/groups/info.hpp"
 #include "session/config/user_groups.hpp"
+#include "session/version.h"
 
 namespace session::nodeapi {
 ConstantsWrapper::ConstantsWrapper(const Napi::CallbackInfo& info) :
@@ -30,6 +31,10 @@ Napi::Object ConstantsWrapper::Init(Napi::Env env, Napi::Object exports) {
              ObjectWrap::StaticValue(
                      "COMMUNITY_FULL_URL_MAX_LENGTH",
                      Napi::Number::New(env, session::config::community::FULL_URL_MAX_LENGTH),
+                     napi_enumerable),
+             ObjectWrap::StaticValue(
+                     "LIBSESSION_UTIL_VERSION",
+                     Napi::String::New(env, LIBSESSION_UTIL_VERSION_FULL),
                      napi_enumerable)});
 
     // export object as javascript module

Diff for: update_version.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+set -e
+# set -x
+
+VERSION_FILE="src/version.ts"
+rm $VERSION_FILE
+export LIBSESSION_NODEJS_VERSION=$(node -p "require('./package.json').version")
+# sadly, this is most likely only working on unix
+LIBSESSION_NODEJS_COMMIT_SHA=$(git rev-parse HEAD)
+
+echo "Updating LIBSESSION_NODEJS_VERSION: $LIBSESSION_NODEJS_VERSION"
+echo "Updating LIBSESSION_NODEJS_COMMIT_SHA: $LIBSESSION_NODEJS_COMMIT_SHA"
+
+echo "export const LIBSESSION_NODEJS_VERSION = '$LIBSESSION_NODEJS_VERSION';" > $VERSION_FILE
+echo "export const LIBSESSION_NODEJS_COMMIT_SHA = '$LIBSESSION_NODEJS_COMMIT_SHA';" >> $VERSION_FILE
+
+echo "\n'$VERSION_FILE' updated to:"
+cat $VERSION_FILE
+