Release

Release

This page will describe how to create and publish a new Litr release. The current release process is half manual, half automated, therefore perfectly balanced.

Create a release

Update version

Update your new version inside src/core/Version.hpp, commit and create a tag as well. This can be done as follows (example version):

git add src/core/Version.hpp. # Add changed version
git commit -m "Release version 1.0.0-alpha.X"
git tag -a "v1.0.0-alpha.X" -m "Release version 1.0.0-alpha.X"
git push && git push origin --tags

Build release

Inside the repository run the following command (you already need Litr installed) and follow the instructions:

litr release

This will create a new release under build/publish containing all needed files.

macOS

The current release is a macOS release for Homebrew. The formula can be found here: https://github.com/krieselreihe/homebrew-litr

The files under build/publish are the files that need to be attached to the GitHub release (all of them). Take the url to the archive as well as the generated sha256 hash. For example:

https://github.com/krieselreihe/litr/releases/download/v1.0.0-alpha.1/litr-mac-1.0.0-alpha.1.tar.gz
https://github.com/krieselreihe/litr/releases/download/v1.0.0-alpha.1/litr-mac-1.0.0-alpha.1-sha256.txt

Update the formula in https://github.com/krieselreihe/homebrew-litr/blob/main/Formula/litr.rb to the latest release:

class Litr < Formula
  desc "Litr (Language Independent Task Runner) lets you configure and then run any tasks you want for any language."
  homepage "https://github.com/krieselreihe/litr"
  url "..."     # Url to the tar.gz file
  sha256 "..."  # Here comes the hash
  version "..." # Full version number

  def install
    bin.install "litr"
  end
end

Push the new changes to the homebrew-litr repo and create the GitHub release.

GitHub Release

The GitHub release should contain the following information:

Release Title: e.g. v1.0.0-alpha.x, this is the tag name for the release

Content:

This is a **non production**, release of Litr (_Language Independent Task Runner_) [[Milestone](https://github.com/krieselreihe/litr/milestone/1)].

## Platform support

This release is only build and tested on {{PLATFORM}} and can be installed via {{PACKAGE_MANAGER}}. If you want to run Litr in another environment you need to build it from source. You can find out how inside the [CONTRIBUTING.md](https://github.com/krieselreihe/litr/blob/main/CONTRIBUTING.md) provided in the repo root.

## Changes since last release

* Some change that was made [{{COMMIT_HASH}}]
* ...

* * *

**Remember**, this is still an alpha. [Report any bugs](https://github.com/krieselreihe/litr/issues). Feedback welcome: info@krieselreihe.com 

Done.

Other platform

Currently not supported [#37, #38].