Skip to content

CHANGELOG.md

Latest commit

 

History

History
37 lines (26 loc) · 1.29 KB

CHANGELOG.md

File metadata and controls

37 lines (26 loc) · 1.29 KB
Raw

CHANGELOG

Versioning

This library is versioned based on Semantic Versioning (SemVer).

Note: while the version is in the 0.x.x range, the API is unstable. When using this library it should be pinned to an exact version to prevent unexpected breaking.

Version scoping

The scope of what is covered by the version number excludes:

  • error messages; the text of the messages can change, unless specifically documented.

Releasing new versions

  • create a release branch
  • update the changelog below
  • update version and copyright-years in ./LICENSE.md and ./src/terminal/init.lua (in doc-comments header, and in module constants)
  • create a new rockspec and update the version inside the new rockspec:
    cp terminal-scm-1.rockspec ./rockspecs/terminal-X.Y.Z-1.rockspec
  • test: run make test and make lint
  • clean and render the docs: run make clean and make 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/terminal-X.Y.Z-1.rockspec --api-key=ABCDEFGH
  • test the newly created rock:
    luarocks install terminal

Version history

Version 0.1.0, released 07-Jun-2026

  • initial release