Skip to content

dividat/ocaml-semver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ocaml-semver

Library for handling semantic version numbers (Semver 2.0.0) in OCaml.

Purpose

This library provides basic functions for working with semantic version numbers:

  • Parsing and printing version strings
  • Comparing version numbers for precedence
  • Checking validity of version numbers according to the Semver spec

Please refer to the module documentation for its API.

Local development

The following dependencies are required:

  • ocaml
  • opam
  • m4
  • pkg-config

Opam needs to be initialized:

$ opam init

Library dependencies can be installed with:

$ make install-deps

Make sure to have an updated shell environment:

$ eval $(opam env)

Then you can run the test suite with:

$ make test

Publishing to opam

Whenever a new tag is pushed, you can publish the new version to opam.

The following dependencies are required to build opam-publish:

  • ocaml
  • opam
  • m4
  • pkgconfig
  • openssl
  • gmp

Contributing

Contributions are welcome in the form of issues or pull requests. Please remember to:

  1. Explain the intended purpose of your change and provide enough context for others to follow your reasoning.
  2. Add documentation for new (or existing!) functionality.
  3. Include tests to help ensure correctness of added code.

Copyright and Licensing

(C) 2020 Dividat AG.

Published under MIT license.