This library is versioned based on Semantic Versioning (SemVer).
The scope of what is covered by the version number excludes:
- error messages; the text of the messages can change, unless specifically documented.
- create a release branch
- update the changelog below
- update version and copyright-years in
./LICENSE.mdand./src/[module-name]/init.lua(in doc-comments header, and in module constants) - create a new rockspec and update the version inside the new rockspec:
cp [module-name]-scm-1.rockspec ./rockspecs/[module-name]-X.Y.Z-1.rockspec - test: run
make testandmake lint - clean and render the docs: run
make cleanandmake docs - commit the changes as
release X.Y.Z - push the commit, and create a release PR
- after merging tag the release commit with
X.Y.Z - upload to LuaRocks:
luarocks upload ./rockspecs/[module-name]-X.Y.Z-1.rockspec --api-key=ABCDEFGH - test the newly created rock:
luarocks install [module-name]
- a fix
- a change
- initial release