Merge pull request #227 from qzhuyan/dev/william/update-packaging

fixing release script

.github/workflows/main.yml

@@ -3,7 +3,7 @@ on: [push, pull_request]
 
 jobs:
   mac:
-    timeout-minutes: 45
+    timeout-minutes: 60
     strategy:
       fail-fast: false
       matrix:

CMakeLists.txt

@@ -82,12 +82,12 @@ set(QUIC_BUILD_PERF "OFF")
 set(QUIC_TLS_SECRETS_SUPPORT "ON")
 
 configure_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/quicer_vsn.hrl.in
+    ${CMAKE_CURRENT_SOURCE_DIR}/templates/quicer_vsn.hrl.in
     ${CMAKE_CURRENT_SOURCE_DIR}/include/quicer_vsn.hrl
 )
 
 configure_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/c_src/quicer_vsn.h.in
+    ${CMAKE_CURRENT_SOURCE_DIR}/templates/quicer_vsn.h.in
     ${CMAKE_CURRENT_BINARY_DIR}/c_src/quicer_vsn.h
 )
 
@@ -167,7 +167,8 @@ add_dependencies(quicer_static msquic)
 set_target_properties(quicer_nif
     PROPERTIES
         LIBRARY_OUTPUT_NAME quicer_nif
-        VERSION ${QUICER_ABI_VERSION}-${QUICER_VERSION}
+        VERSION ${QUICER_VERSION}
+        SOVERSION ${QUICER_ABI_VERSION}
 )
 include(GNUInstallDirs)
 install(TARGETS quicer_nif LIBRARY DESTINATION ${PROJECT_SOURCE_DIR}/priv/)

Makefile

@@ -24,6 +24,7 @@ distclean:
 	$(REBAR) unlock --all
 	rm -rf _build erl_crash.dump rebar3.crashdump
 	rm -rf c_build/*
+	rm -rf priv/*
 
 .PHONY: xref
 xref:

build.sh

@@ -46,8 +46,9 @@ download() {
 
     echo "$(cat "_packages/${PKGNAME}.sha256") _packages/${PKGNAME}" | sha256sum -c || return 1
 
-    gzip -c -d "_packages/${PKGNAME}" > "$TARGET_SO"
-    erlc -I include src/quicer_nif.erl
+    tar zxvf "_packages/${PKGNAME}" -C $(dirname "$TARGET_SO")
+
+    erlc -I include -I priv src/quicer_nif.erl
     if erl -noshell -eval '[_|_]=quicer_nif:module_info(), halt(0).'; then
         res=0
     else
@@ -66,7 +67,7 @@ release() {
     fi
     mkdir -p _packages
     TARGET_PKG="_packages/${PKGNAME}"
-    gzip -c "$TARGET_SO" > "$TARGET_PKG"
+    tar czvf "$TARGET_PKG" -C $(dirname "$TARGET_SO") --exclude include --exclude share --exclude .gitignore .
     # use openssl but not sha256sum command because in some macos env it does not exist
     if command -v openssl; then
         openssl dgst -sha256 "${TARGET_PKG}" | cut -d ' ' -f 2  > "${TARGET_PKG}.sha256"
@@ -90,3 +91,10 @@ else
         build
     fi
 fi
+
+## workaround for emqx forked rebar3
+if ([ -n $REBAR_DEPS_DIR ] && [ $(realpath -P "${REBAR_DEPS_DIR}/quicer/priv") != "${PWD}/priv" ]);
+then
+    cp  -r priv/* "${REBAR_DEPS_DIR}/quicer/priv/"
+    cp include/quicer_vsn.hrl "${REBAR_DEPS_DIR}/quicer/include/"
+fi

include/quicer_vsn.hrl

@@ -0,0 +1,19 @@
+%%--------------------------------------------------------------------
+%% Copyright (c) 2023 EMQ Technologies Co., Ltd. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%--------------------------------------------------------------------
+-ifndef(QUICER_VSN_HRL).
+-define(QUICER_VSN_HRL, true).
+-define(QUICER_ABI_VERSION, 1).
+-endif.

rebar.config

@@ -1,4 +1,5 @@
-{erl_opts, [debug_info]}.
+{erl_opts, [ debug_info
+           ]}.
 
 {pre_hooks,
   [{"(linux|darwin|solaris)", compile, "make build-nif"}
@@ -29,6 +30,10 @@
  ]
 }.
 
+{artifacts, [ "include/quicer_vsn.hrl"
+            , "priv/libquicer_nif.so"
+            ]}.
+
 {relx, [{release, {quicer, git},
          [quicer]},
         {dev_mode, true},

src/quicer_nif.erl

@@ -69,7 +69,6 @@
 -include("quicer.hrl").
 -include("quicer_types.hrl").
 -include("quicer_vsn.hrl").
--include_lib("snabbkaffe/include/snabbkaffe.hrl").
 
 -spec abi_version() -> integer().
 abi_version() ->
@@ -103,9 +102,6 @@ init(ABIVsn) ->
                   ok
           end;
       {error, _Reason} = Res->
-          %% load fail, but beam will keep using current vsn if presents.
-          ?tp_ignore_side_effects_in_prod(debug,
-                                          #{module => ?MODULE, event => init, result => Res}),
           Res
   end.
 -spec open_lib() ->