caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Ashish Agarwal <agarwal1975@gmail.com>
To: Gabriel Scherer <gabriel.scherer@gmail.com>
Cc: Basile Starynkevitch <basile@starynkevitch.net>,
	David CHEMOUIL <David.Chemouil@onera.fr>,
	 caml users <caml-list@inria.fr>
Subject: Re: [Caml-list] releasing and publishing an OCaml program
Date: Sat, 17 Oct 2015 13:25:54 -0400	[thread overview]
Message-ID: <CAMu2m2K-qE9qKJtj_D44iRPDAK2SAWBGvvJ9nHYfmCXYx9+tuw@mail.gmail.com> (raw)
In-Reply-To: <CAPFanBFhhKOke+SrwoXW4xRms8K4Y_1qGTvXsCvAnjEF4+cTHg@mail.gmail.com>

[-- Attachment #1: Type: text/plain, Size: 3712 bytes --]

I have this in my OMake files:

if $(test -e .git)
  GIT_COMMIT = 'Some "$(shell git rev-parse HEAD)"'
  export
else
  GIT_COMMIT = 'None'
  export

I also define VERSION manually, but ideally I should extract the version
from my opam file.

Given those, I use m4 as follows to generate an About module for most of my
projects.

m4 -D VERSION=$(VERSION) -D GIT_COMMIT=$(GIT_COMMIT) about.ml.m4 > about.ml

$ cat about.ml.m4
(** General information about this project. *)

(** Version: [VERSION] *)
let version = "VERSION"

(** Git commit if known: [GIT_COMMIT] *)
let git_commit = GIT_COMMIT



On Sat, Oct 17, 2015 at 3:22 AM, Gabriel Scherer <gabriel.scherer@gmail.com>
wrote:

> For reference, an ocamlbuild version would look like this:
>
> open Ocamlbuild_plugin
>
> let () = dispatch (function
>   | After_rules ->
>      rule "version file"
>           ~prod:"version.ml"
>           ~doc:"generate a file with version information:
>                 Version.commit is the HEAD commit at the time of building,
>                 Version.tag is the name of the last git tag"
>           (fun _env _build ->
>            let trim = "tr -d '\r\n'" in
>            let commit = run_and_read ("git rev-parse HEAD |" ^ trim) in
>            let tag = run_and_read ("git describe --abbrev=0 --tags |" ^
> trim) in
>            let code = Printf.sprintf
>                         "let commit = %S\n\
>                          let tag = %S\n"
>                         commit tag in
>            Echo ([code], "version.ml");
>           )
>   | _ -> ()
> );;
>
> On Fri, Oct 16, 2015 at 9:29 PM, Basile Starynkevitch
> <basile@starynkevitch.net> wrote:
> > On 10/16/2015 08:24 PM, David CHEMOUIL wrote:
> >>
> >> Hi,
> >>
> >> I am looking for a self-contained, to the point, documentation or
> tutorial
> >> detailing steps, or even commands and scripts to run in order to
> release and
> >> publish an OCaml-programmed piece of software.
> >
> >
> >>
> >> So common tasks we'd like to automate are quite simple: adding the
> commit
> >> number and/or a build number in the OCaml source code (e.g. to display
> it
> >> when running the program),
> >
> >
> > This is not specific to Ocaml. It is a matter of build process.
> >
> > Assuming a Linux system, you might have some rule in your Makefile
> similar
> > to the (untested) one below:
> >
> > ML_SOURCES=$(wildcard [a-z]*.ml)
> > ML_INTERFACES=$(wildcard [a-z]*.mli)
> > MD5SUM= md5sum
> >
> > _timestamp.ml:
> >     date +'let my_timestamp="%c";;' > _timestamp.tmp
> >
> >     (echo -n 'let my_lastgitcommit ="' ; \
> >        git log --format=oneline --abbrev=12 --abbrev-commit -q  \
> >          | head -1 | tr -d '\n\r\f\"' ; \
> >        echo '";;') >> _timestamp.tmp
> >     (echo -n 'let my_checksum ="'; cat $(sort $(ML_SOURCES)) $(sort
> > $(ML_INTERFACES))| $(MD5SUM) | cut -d' ' -f1 | tr -d '\n\r\f\"\\' ; echo
> > '";') >> _timestamp.tmp
> >     mv _timestamp.tmp _timestamp.ml
> >
> > Cheers
> >
> > --
> > Basile STARYNKEVITCH         http://starynkevitch.net/Basile/
> > email: basile<at>starynkevitch<dot>net mobile: +33 6 8501 2359
> > 8, rue de la Faiencerie, 92340 Bourg La Reine, France
> > *** opinions {are only mine, sont seulement les miennes} ***
> >
> >
> >
> > --
> > Caml-list mailing list.  Subscription management and archives:
> > https://sympa.inria.fr/sympa/arc/caml-list
> > Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> > Bug reports: http://caml.inria.fr/bin/caml-bugs
>
> --
> Caml-list mailing list.  Subscription management and archives:
> https://sympa.inria.fr/sympa/arc/caml-list
> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> Bug reports: http://caml.inria.fr/bin/caml-bugs
>

[-- Attachment #2: Type: text/html, Size: 6231 bytes --]

  reply	other threads:[~2015-10-17 17:26 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-16 18:24 David CHEMOUIL
2015-10-16 19:29 ` Basile Starynkevitch
2015-10-17  7:22   ` Gabriel Scherer
2015-10-17 17:25     ` Ashish Agarwal [this message]
2015-10-17 19:42     ` ygrek
2015-10-19  8:50       ` Kenneth Adam Miller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAMu2m2K-qE9qKJtj_D44iRPDAK2SAWBGvvJ9nHYfmCXYx9+tuw@mail.gmail.com \
    --to=agarwal1975@gmail.com \
    --cc=David.Chemouil@onera.fr \
    --cc=basile@starynkevitch.net \
    --cc=caml-list@inria.fr \
    --cc=gabriel.scherer@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).