Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 3.2 KB

DEVELOPMENT.md

File metadata and controls

112 lines (78 loc) · 3.2 KB
Raw

Development

Dev Setup Requirements

This is a native OCaml project, so you will need the following tools:

  • OCaml (we work on version 4.06.1 mostly, but other versions should work as well)
  • dune >= 1.11.4
  • reason >= 3.5.2

Easiest way to install these is via the opam package manager. We don't use esy for simplicity reasons.

# Create / switch to ocaml 4.06.1
opam switch create 4.06.1

# Install deps
opam install reason.3.6.0 dune.1.11.4 --yes

After that, install some npm dependencies as well:

npm install

Build genType

# Builds the project
npm build

# Alternatively
dune build

When the compilation went through successfully, you'll now find the executable in _build/default/src/GenType.exe. Running the executable:

_build/default/src/GenType.exe --version

Test genType

Make sure to always run the tests before submitting any changes (CI usually takes longer to give you feedback).

npm test

Automated Releases (for Maintainers)

The project is compatible with the npm version workflow. After using the npm version [major|minor|patch|...] command, npm will automatically tag the current commit, bump all the necessary version numbers (also the number in src/Version.re) and push it to the current remote branch.

When a tag is pushed, CircleCI will create a package to the Github releases releases page, which can later be released to npm.

This CI process only covers the newest genType releases (v3+), which are based on BuckleScript 6.x. This version is based on OCaml 4.06 and is not compatible with any BuckleScript version below 6.x (those are based on OCaml 4.02).

Here are the concrete commands to run:

# Make sure to commit & push all current changes, the working branch should be clean
# and synced up with your remote branch

# Also make sure that your current branch is explicitly set to the relevant remote
# (`git push` instead of `git push origin master`)
git status

# For patches (0.0.X+1)
npm version patch

# For minor (0.X+1.0)
npm version minor

# For major (X+1.0.0)
npm version major

Releasing to npm (Maintainers only)

The releasing mechanism downloads the platform dependent artifacts stored on the Github releases tab, so make sure to first do an automated release as stated above (npm version ...).

After the CIs are done releasing the built binaries, do following command on a unix-like system (no Windows supported):

node scripts/download_dist.js

This will download the prepared npm package from the genType Github releases tab to the root of your project with the name gentype-$version.tgz. This is a tgz file ready to be released to npm!

# Dry run for testing
npm publish gentype-*.tgz --dry-run

# Publish package as @latest
npm publish gentype-*.tgz

# Publish package with @beta tag
npm publish gentype-*.tgz --tag beta

Consult the npm publish documentation for more options. In case you get an ENEEDAUTH error, use npm adduser and authenticate with your npm account first.