DEVELOPMENT.md

Developing ngx_mruby

This is a collection of random tips to help ngx_mruby developers.

Recommended development environment

We use vagrant for development of ngx_mruby.

You may want to develop in same development environment.

Setup development environment

cd ngx_mruby
vagrant up       # run provisioner automatically
vagrant ssh

Test in development environment using ubuntu 18.04

cd ngx_mruby/
sh test.sh

Format C source code

Run apply-clang-format script.

cd ngx_mruby
sh apply-clang-format

Adding newer version nginx support

Edit nginx_version and .travis.yml. See https://github.com/matsumotory/ngx_mruby/commit/02ddb38b68702d9abe8fb0a8c172ee1d80ad2b2d for example.

TODO: retirement policy

Updating mruby

If you want to update in-tree mruby to latest version, you can use update-mruby-subtree script. It adds the mruby upstream repo as dep-mruby and pull all changes to the current branch.

git checkout -b BRANCH
sh update-mruby-subtree

If you want to update to a specific commit, you can specify a ref.

sh update-mruby-subtree REF

Updating ngx_devel_kit

If you want to update in-tree ngx_devel_kit to latest version, you can use update-devkit-subtree script. It adds the ngx_devel_kit upstream repo as dep-ngx_devel_kit and pull all changes to the current branch.

git checkout -b BRANCH
sh update-devkit-subtree

If you want to update to a specific commit, you can specify a ref.

sh update-devkit-subtree REF