Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.29 KB

RELEASE.md

File metadata and controls

61 lines (40 loc) · 2.29 KB

Creating binary packages for your platform

Note: to create the package successfully you will need tools like ocaml, opam, z3, make, git, Madoko, LaTeX, and zip installed.

Note: no cross-platform compilation supported at the moment

  1. Make sure you have installed all the dependences to build F* using the OCaml snapshot (cf. step 3 in INSTALL.md)

  2. Make sure you have the Z3 4.4.1 binary in your $PATH or in the $FSTAR_HOME/bin directory. Please make sure it's precisely this version!

     $ z3 --version
    
  3. Run the following command:

     $ make package -C src/ocaml-output
    
  4. Run the testing of binary packages (described in INSTALL.md)

Release process

  • Find volunteers for creating and testing packages on Windows, Mac, and Linux

  • Make sure that F* builds, passes all the tests, and that creating binary packages works well

  • (Maybe one day) Close all issues that were already fixed (helps getting nicer release notes, but only works well if people actually use the tracker for their work).

  • Bump the version in version.txt

  • Push all changes to the OCaml snapshot

  • Draft a new release on GitHub using the version number (e.g. v0.9.2.0) as the tag, a precise commit id (not a branch!) as the target, the version maybe followed by some mnemonic as the release title, and a description of the changes. Can use GitHub for a list of changes between two releases or of issues closed between two dates.