yoriyuki / Camomile

A Unicode library for OCaml
Other
125 stars 26 forks source link

Topkg #65

Closed rgrinberg closed 6 years ago

rgrinberg commented 6 years ago

As promised, here's basic topkg support.

Here's how to use it:

The release process with topkg is as follows:

topkg tag # tags a release using the latest version number in the CHANGELOG.md
topkg distrib --skip-build --skip-lint --skip-tests # creates a tarball that will be the release
topkg publish distrib --verbose # uploads the tarball the github
topkg opam pkg # creates the local opam package submission in _build
topkg opam submit # requires opam publish. if you don't have it then simply copy paste the files in _build into your local opam-repository and make the PR yourself.

Note that it's important to create our own tarball here. Github likes to change the archives they host which correspond to git tags subtly, and hence invalidate the checksums. Uploading our own tarballs protects against this tampering.

To actually make the github submission, we will need to use opam publish. Due to unfortunate circumstances, opam-publish is only available on OCaml 4.05.0. So if you have a 4.05.0 switch then great. Otherwise, you will have to do the last step manually. Doing it manually should be as simple as copying the files to your local opam-repository and creating a commit and a PR.

yoriyuki commented 6 years ago

Uploaded and submitted to opam, but Travis-CI falied.