Skip to content

Latest commit

 

History

History
41 lines (36 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

41 lines (36 loc) · 1.24 KB

Contributing

Setup

First you need to fetch libsodium, checkout the right tag and then you need to install dependencies:

npm run fetch-libsodium
npm install

Release

  • Change the title of "Next" to the next version in the changelog
  • Update the link to the current released docs version in the README file
  • Tag a new release and push to Github, triggering CI services to test and build artifacts for windows (32 and 64 bit), MacOS (64 bit) and Linux (64 bit)
  • Produce arm7l artifacts. We use a Raspberry 3+ Model B with raspbian for this, following the steps from .travis.yml with stock version of gcc, autotools and make:
    npm run fetch-libsodium
    npm install
    npm test
    npm run prebuilds
    tar --create --verbose --file="`git describe --tags`-linux-`uname -m`.tar" --directory "./prebuilds" .
    
    This tar file should be uploaded to Github Release like the artifacts produced by CI services.
  • Clean out the repository on your local computer:
    git submodule foreach --recursive git clean -x -d -f`
    git clean -x -d -f
    
  • Add prebuild artifacts:
    • mkdir prebuilds
    • Download all artifacts from Github Releases
    • Extract tar archives and zip files into prebuilds
  • npm publish
  • Enjoy!