Erlang build tool that makes it easy to compile and test Erlang applications, port drivers and releases.
Find a file
Arjan Scherpenisse cc67814b65 ct: skip instead of halt on missing/unknown suite
This allows `rebar ct suites=abc` to consider all suites when
you have a rebar setup with multiple sub_dirs.

Previously, rebar halted after it could not find the suite in the
first dir. But the suite might be present in another dir (when
sub_dirs contains multiple dirs).

This commit makes it so instead of halting, it prints a warning and
continues with looking for the suite in the other `sub_dir`s.

Note -- This uses try/catch to cause the test to be skipped because
otherwise I needed to adjust the return values of 4 functions, the
code path is pretty deeply nested here. Otherwise the whole call chain
needed to be adjusted for this return value:

`run_test -> make_cmd -> get_suites -> find_suite_path`

IMHO, I think for exceptional cases like this it is fine to use throw;
specially since only the {skip} is catched and nothing else.
2012-10-31 20:37:42 -06:00
ebin Fix version string 2012-08-09 13:04:08 +02:00
include Use separate dirs for eunit and qc 2012-08-09 18:37:26 +02:00
inttest Add support for non-Erlang/OTP (raw) dependencies 2012-10-11 02:06:08 -05:00
priv bash completion: remove duplicate cmd 2012-08-09 15:16:22 +02:00
src ct: skip instead of halt on missing/unknown suite 2012-10-31 20:37:42 -06:00
test eunit: analyze coverage only for cover compiled modules 2012-09-13 22:30:30 +02:00
.gitignore Update .gitignore (add .eunit and deps) 2012-08-13 00:02:12 +02:00
.hgignore Add .gitignore to the source tree 2010-10-03 16:00:15 +02:00
.hgtags Added tag RELEASE-1 for changeset e8747041ef63 2009-12-18 15:11:54 -07:00
.travis.yml Updating .travis.yml for new primary repo 2012-10-31 06:11:11 -06:00
bootstrap bootstrap: fix and enhance VCS_INFO handling 2012-08-13 00:07:00 +02:00
bootstrap.bat add bat scripts for bootstrap and rebat (windows doesn't understand shebang), make bootstrap work on windows 2010-08-02 20:35:26 +03:00
dialyzer_reference Revert arch string changes 2012-10-29 16:01:28 +01:00
LICENSE Added HACKING, LICENSE and THANKS files 2009-12-31 20:31:22 +01:00
Makefile Add 'qc' cmd and rename eunit-compile to test-compile 2012-07-23 16:22:06 +02:00
NOTES.org Initial commit 2009-11-25 15:23:42 -07:00
README.md Update travis-ci link. 2012-10-31 06:14:05 -06:00
rebar.config Use R15B02 EUnit {test,M,F} primitive as suggested by Richard Carlsson 2012-09-06 00:50:46 +02:00
rebar.config.sample Add support for non-Erlang/OTP (raw) dependencies 2012-10-11 02:06:08 -05:00
rebar.config.script Refactor ci support 2012-07-01 22:31:50 +02:00
THANKS Add Magnus Henoch to THANKS 2012-10-22 22:10:29 +02:00

rebar

rebar 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).

Building

Information on building and installing Erlang/OTP can be found here (more info).

Dependencies

To build rebar you will need a working installation of Erlang R13B03 (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 rebar from:

https://github.com/rebar/rebar/wiki/rebar

Building rebar

$ git clone git://github.com/rebar/rebar.git
$ cd rebar
$ ./bootstrap
Recompile: src/getopt
...
Recompile: src/rebar_utils
==> 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

Pull requests and branching

Use one topic branch per pull request.

Do not commit to master in your fork.

Provide a clean branch without any merge commits from upstream.

Usually you should squash any intermediate commits into the original single commit.

Code style

Do not introduce trailing whitespace.

Do not mix spaces and tabs.

Do not introduce lines longer than 80 characters.

erlang-mode (emacs) indentation is preferred. vi-only users are encouraged to give Vim emulation (more info) a try.

Writing Commit Messages

Structure your commit message like this:

One line summary (less than 50 characters)

Longer description (wrap at 72 characters)

Summary

  • Less than 50 characters
  • What was changed
  • Imperative present tense (fix, add, change)
    • Fix bug 123
    • Add 'foobar' command
    • Change default timeout to 123
  • No period

Description

  • Wrap at 72 characters
  • Why, explain intention and implementation approach
  • Present tense

Atomicity

  • Break up logical changes
  • Make whitespace changes separately

Run checks

Before you submit a patch, run make check to execute the test suite and check for xref and Dialyzer warnings. You may have to run make clean first.

Dialyzer warnings are compared against a set of safe-to-ignore warnings found in dialyzer_reference. xref is run with custom queries to suppress safe-to-ignore warnings.

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: