You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Tristan Sloughter 2ba2002a80 Update guide.md пре 10 година
bootstrap switch ct provider to use external provider behavior пре 10 година
doc Update guide.md пре 10 година
include use CONFIG_DIR of rebar3 for config directories пре 10 година
priv Minor template fixes пре 10 година
src fix callback r14 support пре 10 година
test pass command as arg to run_aux for now пре 10 година
.gitignore add plt to gitignore пре 10 година
.travis.yml switch travis deploy as well to master branch пре 10 година
CONTRIBUTING.md Fix #176 пре 11 година
LICENSE Added HACKING, LICENSE and THANKS files пре 15 година
Makefile slowly widdling away at dialyzer errors пре 10 година
README.md link to mailing-list pre-alpha announcement in README пре 10 година
RELEASE-NOTES.md Bump to 2.5.0 пре 11 година
THANKS Merge branch 'erl-args-to-end' of https://github.com/NineFX/rebar into NineFX-erl-args-to-end пре 10 година
rebar.config fix callback r14 support пре 10 година
rebar.config.sample Merge pull request #285 from nevar/fix_inheritance пре 11 година
rebar.config.script Clean up rebar.config.script пре 11 година

README.md

rebar

rebar 3.0 is an Erlang build tool that makes it easy to compile and test Erlang applications, port drivers and releases.

Build Status

rebar is a self-contained Erlang script, so it's easy to distribute or even embed directly in a project. Where possible, rebar uses standard Erlang/OTP conventions for project structures, thus minimizing the amount of build configuration work. rebar also provides dependency management, enabling application writers to easily re-use common libraries from a variety of locations (git, hg, etc).

3.0 Pre-Alpha

This is an experimental branch, considered to be pre-alpha, and still very unstable. Use at your own risk, and expect no support. See the related announcement.

Compatibility with rebar 2.0 has been broken, and features removed to limit scope.

Commands

Command Description
compile Build project
clean Remove project apps beam files
ct Run Common Test suites
do Higher-order provider to run multiple tasks in sequence
dialyzer Run the Dialyzer analyzer on the project
eunit Run eunit tests
help Print help for rebar or task
new Create new rebar project from templates
pkgs List available packages
release Build release of project
shell Run shell with project apps in path
tar Package release into tarball
update Update package index
upgrade Fetch latest version of dep
version Print current version of Erlang/OTP and rebar

Changes

  • Fetches and builds deps if missing when running any command that relies on them
  • Automatically recognizes apps and lib directory structure
  • escriptize requires escript_top_level_app set in rebar.config
  • Relx for releases

Gone

  • Reltool integeration

Providers

Providers are the modules that do the work to fulfill a user's command.

Example:

-module(rebar_prv_something).

-behaviour(rebar_provider).

-export([init/1,
         do/1]).

-define(PROVIDER, something).
-define(DEPS, []).

%% ===================================================================
%% Public API
%% ===================================================================

-spec init(rebar_state:state()) -> {ok, rebar_state:state()}.
init(State) ->
    State1 = rebar_state:add_provider(State, rebar_provider:create([{name, ?PROVIDER},
                                                                    {module, ?MODULE},
                                                                    {bare, false},
                                                                    {deps, ?DEPS},
                                                                    {example, "rebar dummy"},
                                                                    {short_desc, "dummy plugin."},
                                                                    {desc, ""},
                                                                    {opts, []}])),
    {ok, State1}.

-spec do(rebar_state:state()) -> {ok, rebar_state:state()}.
do(State) ->
    %% Do something
    {ok, State}.

Building

Recommended installation of Erlang/OTP is binary packages from Erlang Solutions. For source it is recommended you use erln8 or kerl.

Dependencies

To build rebar you will need a working installation of Erlang R15 (or later).

Should you want to clone the rebar repository, you will also require git.

Downloading

You can download a pre-built binary version of rebar3 based on the last commit from:

https://s3.amazonaws.com/rebar3/rebar3

Building rebar

$ git clone git://github.com/tsloughter/rebar.git
$ cd rebar
$ ./bootstrap/bootstrap
==> rebar (compile)
Congratulations! You now have a self-contained script called "rebar" in
your current working directory. Place this script anywhere in your path
and you can use rebar to build OTP-compliant apps.

Contributing to rebar

Please refer to CONTRIBUTING.

Community and Resources

In case of problems that cannot be solved through documentation or examples, you may want to try to contact members of the community for help. The community is also where you want to go for questions about how to extend rebar, fill in bug reports, and so on.

The main place to go for questions is the rebar mailing list. If you need quick feedback, you can try the #rebar channel on irc.freenode.net. Be sure to check the wiki first, just to be sure you're not asking about things with well known answers.

For bug reports, roadmaps, and issues, visit the github issues page.

General rebar community resources and links: