Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release Note #1

Open
ChiaMineJP opened this issue Jul 3, 2021 · 0 comments
Open

Release Note #1

ChiaMineJP opened this issue Jul 3, 2021 · 0 comments

Comments

@ChiaMineJP
Copy link
Member

ChiaMineJP commented Jul 3, 2021

Changelog

Fixed incorrect toolchain file path in js_build.sh

incorrect:
cmake ../ -DCMAKE_TOOLCHAIN_FILE=$(realpath $(which emcc))/cmake/Modules/Platform/Emscripten.cmake
correct:
cmake ../ -DCMAKE_TOOLCHAIN_FILE=$(dirname $(realpath $(which emcc)))/cmake/Modules/Platform/Emscripten.cmake

Remove deprecatated js tests

Test files except for js-bindings/tests/test.js has been long deprecated and no longer used for a while, including GitHub Actions.
So I want to remove those legacy test files to lower management cost.
Currently I just renamed js-bindings/tests to js-bindings/tests_old.

Clear js_build folder on every build

Current building mechanism is like copy and paste. Files removed in source dir are left undeleted on build dir.
It is necessary to clear all contents in build dir before building js files.

Use only npm and ignore yarn.

In js_test.sh, there are lines which inspect whether yarn command is installed on the system, and if not, choose npm command as a package manager.
It is great for yarn users. I personally love yarn very much, as it is very fast.
However, only one of package-lock.json of npm or yarn.lock of yarn can be stored as a depenency-lock file in this repository because they conflicts.
So I choose npm as a package manager here because having yarn on a system is a optional while npm is not.

Add jest to test framework

Adopting well-known test framework can attract more people to write test code.

Simplify test execution

Prerequisite

You need to have NodeJS and emscripten installed on your system.
For emscripten installation see https://emscripten.org/docs/getting_started/downloads.html

  1. Build
    cd bls-signatures
    ./js_build.sh
  2. Test
    ./js_test.sh
    or
    cd js-bindings
    npm test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant