Skip to content

Commit 23a59c7

Browse files
committed
v0.1.1 bump
1 parent 27b5f72 commit 23a59c7

File tree

3 files changed

+33
-4
lines changed

3 files changed

+33
-4
lines changed

CHANGELOG.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1818
### Security
1919

2020

21+
## [0.1.1] - 2018-01-24
22+
23+
### Added
24+
- README documentation for the actual unit tests
25+
26+
2127
## [0.1.0] - 2018-01-24
2228
### Added
2329
- Unit testing support
@@ -47,6 +53,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
4753
- Skeleton for gem with working unit tests
4854

4955

50-
[Unreleased]: https://github.com/ifreecarve/arduino_ci/compare/v0.1.0...HEAD
56+
[Unreleased]: https://github.com/ifreecarve/arduino_ci/compare/v0.1.1...HEAD
57+
[0.1.1]: https://github.com/ifreecarve/arduino_ci/compare/v0.1.0...v0.1.1
5158
[0.1.0]: https://github.com/ifreecarve/arduino_ci/compare/v0.0.1...v0.1.0
5259
[0.0.1]: https://github.com/ifreecarve/arduino_ci/compare/v0.0.0...v0.0.1

README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci)
22
[![Build Status](https://travis-ci.org/ifreecarve/arduino_ci.svg)](https://travis-ci.org/ifreecarve/arduino_ci)
3-
[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.0)
3+
[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.1)
44

55
# ArduinoCI Ruby gem (`arduino_ci`)
66

@@ -26,7 +26,29 @@ script:
2626
- bundle exec arduino_ci_remote.rb
2727
```
2828
29-
That's literally all there is to it on the repository side. You'll need to go to https://travis-ci.org/profile/ and enable testing for your Arduino project. Once that happens, you should be all set.
29+
That's literally all there is to it on the repository side. You'll need to go to https://travis-ci.org/profile/ and enable testing for your Arduino project. Once that happens, you should be all set. The script will test all example projects of the library and all unit tests.
30+
31+
### Unit tests in `test/`
32+
33+
All `.cpp` files in the `test/` directory of your Arduino library are assumed to contain unit tests. Each and every one will be compiled and executed on its own.
34+
35+
The most basic unit test file is as follows:
36+
37+
```C++
38+
#include <ArduinoUnitTests.h>
39+
#include "../do-something.h"
40+
41+
unittest(your_test_name)
42+
{
43+
assertEqual(4, doSomething());
44+
}
45+
46+
int main(int argc, char *argv[]) {
47+
return Test::run_and_report(argc, argv);
48+
}
49+
```
50+
51+
This test defines one `unittest` (a macro provided by `ArduionUnitTests.h`), called `your_test_name`, which makes some assertions on the target library. The `int main` section is boilerplate.
3052

3153

3254
## More Documentation

lib/arduino_ci/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module ArduinoCI
2-
VERSION = "0.1.0".freeze
2+
VERSION = "0.1.1".freeze
33
end

0 commit comments

Comments
 (0)