developer_environment.md

Developer Environment

Installation

Project Requirements

For this project you need

• Lua 5.4
• Luarocks 3.*
• Python 3.10
• Poetry

Install on a desktop machine

1. Install poetry following the instructions on their website.

2. Install micromamba as explained on their website

3. To install lua and all luarocks package, run from the project root

   ./scripts/install_conda_packages.sh
   ./scripts/install_luarocks_packages.sh

Install in Vagrant and CI

From the project root run:

1. ./scripts/install_lua_environment.sh
2. Install poetry
   • Already installed in Vagrant
   • In Github Actions we currently use the following action: https://github.com/abatilo/actions-poetry

Usage

Interactive

From the project root run:

source ./scripts/activate_development_environment.sh

Use in scripts and CI

From the project root run:

source ./scripts/run_in_dev_env.sh <command>