]> git.codecow.com Git - Monocypher.git/commit
Include version in released source files
authorLoup Vaillant <loup@loup-vaillant.fr>
Sat, 19 Oct 2019 12:44:28 +0000 (14:44 +0200)
committerLoup Vaillant <loup@loup-vaillant.fr>
Sat, 19 Oct 2019 12:44:28 +0000 (14:44 +0200)
commit51a4266d6fdeded9f9cdf9fbd15242963e510470
tree6d2ecd68373124012d1194f0899d7538a5454753
parent1d85d05d6877f6cb12b109471ad07b649e341b28
Include version in released source files

I realised that determining which Monocypher version was used in a
project was not trivial. We could look at Monocypher's code and deduce
the release, but that's tedious and error prone. So I've made those
versions more explicit:

- Source and header files begin by a comment describing the version.
- The pkg-config file created by `make install` include that version.
- The version number of unreleased code (under git) is "__git__"
- The version number of released code is whatever `git describe --tags`
  tells us.
- the "tarball" target in the makefile was changed to the more standard
  "dist".

To release a new version, we just add a tag, then call `makefile dist`.
The version of the released source file will appear at a glance, right
there on the first line.

Note: the release process blindly replaces all instances of "__git__" by
the suitable version number.  This could be used to version things other
than comments, like string constants.
.gitignore
README.md
VERSION.md [deleted file]
makefile
release.sh [new file with mode: 0755]
src/monocypher.c
src/monocypher.h
src/optional/sha512.c
src/optional/sha512.h
tarball_ignore