Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 2.25 KB

Updating-OCaml-Version.md

File metadata and controls

84 lines (50 loc) · 2.25 KB

Instructions for Updating Various Components

Current version

The most recent version that we use is Ocaml 5.2.0. If there are known issues with more recent version of OCaml, we will list them here.

How to update Hazel to use a new version of ocaml

There are new releases of OCaml 2-4 times per year.

To update do the following:

  • opam update

  • opam switch list-available

  • Choose the most recent version, but no later than the public release on ocaml.org (e.g., 5.2.0).

  • Create a new branch called update_ocaml_VERSION where VERSION is the version of OCaml you intend to upgrade to.

    git checkout -b update_ocaml_VERSION

  • opam switch create VERSION, where VERSION is the most recent OCaml version that does not contain a + character (e.g., 5.2.0).

  • make deps

  • opam upgrade

  • make change-deps

  • make repl

  • Make sure the REPL loads correctly.

  • make release

  • Test in Firefox and Chrome.

  • Update the version number in .github/workflows/deploy_branches.yml

    • Update the version number in step 3: Install dependencies and build hazel.
    • Push to github and check deploy status
  • Update the version numbers in README.md.

  • Update the version number and instructions in INSTALL.md.

  • Update the "Current Version" section at the top of this file.

  • Announce the version change on the #hazel-dev channel of the hazelgrove Slack by sending the following message, with the appropriate VERSION:

    @channel
    We have switched `dev` to OCaml version VERSION. You can update to VERSION by doing the following things.
    
    - Merge your branch with either `dev` or `update_ocaml_VERSION` if that is tricky.
    
    - Update your `opam`.
    
      ```
      opam update
      ```
    
      If you get the following warning:
    
      ```
      [WARNING] opam is out-of-date. Please consider updating it (https://opam.ocaml.org/doc/Install.html)
      ```
    
      You may want to update opam by following the instructions for your platform at that link.
    
    - Update your OCaml installation by running the following:
    
      ```
      opam switch create VERSION
      eval $(opam env)
      make deps
      ```
    
    • Verify that the latest version builds by running make clean; make.