YunoHost/ynh-dev
1
0
Fork 0
mirror of https://github.com/YunoHost/ynh-dev.git synced 2024-09-03 20:05:59 +02:00
Code Issues Projects Releases Packages Wiki Activity
Dev environement wrapper, based on Incus, to develop on YunoHost
65 commits 4 branches 0 tags 411 KiB
Shell 85.6%
Python 14.4%
Find a file
opi 06c9caf46d Merge pull request #10 from YunoHost/fix_9 
[fix] #9: 'apt-get' update before installing packages.
2016-10-09 10:54:56 +02:00
LICENSE Initial commit 2015-10-11 19:41:59 +02:00
README.md [up] readme: fedora: use solution which needs to install vagrant 1.8.5. 2016-09-25 15:22:29 +02:00
ynh-dev [fix] #9: 'apt-get' update before installing packages. 2016-10-08 18:49:13 +02:00

README.md

ynh-dev, a yunohost dev env

This script is a Command line tool to manage your local development environement for YunoHost With this you can develop on the unstable version of YunoHost quickly.

Setup

Install dependencies

Debian, Ubuntu, Mint

sudo apt-get install vagrant virtualbox git

Fedora

sudo dnf install vagrant git

VirtualBox 5.1.4 only works with Vagrant ≥ 1.8.5. It could be installed from Fedora 25 or rawhide.

Download ynh-dev script

wget https://github.com/YunoHost/ynh-dev/raw/master/ynh-dev
chmod u+x ynh-dev

Host usage

The ynh-dev tool provides 2 usefull command to run into your host machine. One create a development environment by cloning Git repositories, the other one is a helper to run a Vagrant virtual machine in the right place.

Create the environment

./ynh-dev create-env /path/to/dev/env

Run a container

cd /path/to/dev/env
./ynh-dev run ynh.local testing

The run command takes 2 arguments: domain and YunoHost version.

You'll be automatically logged in the VM through ssh.

You probably want to run the postinstall now:

(sudo) yunohost tools postinstall -d ynh.local

## Inside the Virtual machine (VM)

Sharing folder between host and virtual machines

A shared folder between host and virtal machines could ease your development. Once logged into your VM, go to /vagrant to enjoy folder sharing, and take advantages of the ynh-dev script.

Upgrade the container

It will update every debian packages, including YunoHost ones.

/vagrant/ynh-dev upgrade

Use Git repositories

When doing create-env command, every YunoHost package have been cloned in the corresponding path. Use these Git repositories inside the VM (with symlink). Your changes will be available immediatly in your VM.

/vagrant/ynh-dev use-git

Note: These changes can't be reverted now.

Alternatively you can use Git only for one packages (ssowat, yunohost, moulinette, yunohost-admin)

/vagrant/ynh-dev use-git PACKAGE_NAME

Get ip address of your vm

/vagrant/ynh-dev ip

Update ynh-dev script

/vagrant/ynh-dev self-update

More info

yunohost.org/dev_fr (in french) not up-to-date.