Skip to content

Commit

Permalink
Merge pull request #609 from robotology/cleanup/ci
Browse files Browse the repository at this point in the history
Remove  appveyor and Travis CI files
  • Loading branch information
traversaro authored Jan 9, 2020
2 parents 9e58051 + 4d7d598 commit 15ce240
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 243 deletions.
27 changes: 0 additions & 27 deletions .ci/install_debian.sh

This file was deleted.

8 changes: 0 additions & 8 deletions .ci/install_debian_and_script.sh

This file was deleted.

40 changes: 0 additions & 40 deletions .ci/script.sh

This file was deleted.

98 changes: 0 additions & 98 deletions .travis.yml

This file was deleted.

13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,16 @@ In a nutshell, development of new features/bugfixes happens in separated branch.
## Continuous Integration
We use [https://en.wikipedia.org/wiki/Continuous_integration](Continuous Integration) to make
sure that proposed changes in the library do not cause regression. In particular we use
[Travis](https://travis-ci.org/robotology/idyntree) for Linux/OS X and [AppVeyor](https://ci.appveyor.com/project/robotology/idyntree) for Windows.
[GitHub Actions](https://travis-ci.org/robotology/idyntree) for Continuous Integration on Linux, macOS and Windows.

In all this build systems the compilation of the tests is enabled by setting to true
the `IDYNTREE_COMPILE_TESTS` CMake flag.

### Travis
All the dependencies (also the optional one) are enabled in the Travis build.
Almost all the dependencies are enabled in the Linux build.
Furthermore on Linux builds the `IDYNTREE_RUN_VALGRIND_TESTS` flag is enabled, to
run all the tests also under the [`valgrind`](http://valgrind.org/) tool, to spot
any memory-related error, suck of use of initialized memory or memory leak.

You can find the specific iDynTree configuration used in the AppVeyor build in the [`.travis.yml`](https://github.com/robotology/idyntree/blob/master/.travis.yml) file.

Some dependencies or options are disabled on Windows and macOS, and you can find the specific iDynTree configuration used in the GitHub Actions build in the [`.github/workflows/ci.yml`](https://github.com/robotology/idyntree/blob/master/.github/workflows/ci.yml) file.

### AppVeyor
For the time being AppVeyor is just building the iDynTree parts that don't depend on
[KDL](https://github.com/orocos/orocos_kinematics_dynamics), [YARP](https://github.com/robotology/yarp) or [icub-main](https://github.com/robotology/icub-main).

You can find the specific iDynTree configuration used in the AppVeyor build in the [`appveyor.yml`](https://github.com/robotology/idyntree/blob/master/appveyor.yml) file.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
iDynTree [![Build Status](https://travis-ci.org/robotology/idyntree.svg?branch=maste2013-r)](https://travis-ci.org/robotology/idyntree) [![Build status](https://ci.appveyor.com/api/projects/status/1uecfmyvxb2dujt9/branch/master?svg=true)](https://ci.appveyor.com/project/robotology/idyntree/branch/master) [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) [![License: LGPL v2](https://img.shields.io/badge/License-LGPL%20v2-blue.svg)](https://www.gnu.org/licenses/lgpl-2.1) [![ZenHub](https://img.shields.io/badge/Shipping_faster_with-ZenHub-435198.svg)](https://zenhub.com)
iDynTree [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) [![License: LGPL v2](https://img.shields.io/badge/License-LGPL%20v2-blue.svg)](https://www.gnu.org/licenses/lgpl-2.1) [![ZenHub](https://img.shields.io/badge/Shipping_faster_with-ZenHub-435198.svg)](https://zenhub.com)
===========

iDynTree is a library of robots dynamics algorithms for control, estimation and simulation.
Expand Down
52 changes: 0 additions & 52 deletions appveyor.yml

This file was deleted.

10 changes: 2 additions & 8 deletions doc/dev/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,8 @@ test validating the functionality of the MATLAB interface will be automatically
## How to run the Valgrind-based tests
[Valgrind MemCheck](http://valgrind.org/) is a tool to identify memory related software bugs (use of initialize memory, memory leaks, ...). To automatically run the iDynTree test suite under Valgrind, just enabled the `IDYNTREE_RUN_VALGRIND_TESTS` CMake option (together with the `IDYNTREE_COMPILE_TESTS` option).

## How to get notified if my code fails to compile or create a failure in some tests
iDynTree uses [Travis](https://travis-ci.org/robotology/idyntree) and [AppVeyor](https://ci.appveyor.com/project/robotology/idyntree) Continous Integration (CI) services
to make sure that all code commited to the repository. To be notified if some of your commits
failed to pass tests, just sign in [Travis](https://travis-ci.org/) and [AppVeyor](https://ci.appveyor.com/login)
with your GitHub account, and you will automatically receive notifications if your commits cause a failure.

## What are the things that needs to be done before merging a pull request?
* Check if Travis and AppVeyor compiler and run the test without any failure.
* Check if the GitHub Actions jobs compiles and run the test without any failure.

## How to add wrap a new class or function with SWIG
* Include the new header in [bindings/iDynTree.i](bindings/iDynTree.i) . For a little more detailed overview, check [doc/generating-idyntree-matlab-bindings.md](../../doc/generating-idyntree-matlab-bindings.md) .
Expand All @@ -41,7 +35,7 @@ with your GitHub account, and you will automatically receive notifications if yo
* If you add a instantiated template, remember to add it to swig with the `%template` SWIG command.
* Regenerate the MATLAB bindings, following the instructions in https://github.com/robotology/idyntree#matlab-bindings-modifications .
* (Optional) Add a new matlab test testing the new code in `bindings/matlab/tests`.
* The structure of tests in `bindings/matlab/tests` uses [MOxUnit](https://github.com/MOxUnit/MOxUnit) a unit test framework for Matlab and Octave. Please see the MOxUnit documentation and existing tests for understanding the structure of the tests. As the tests are run by `Travis` also on Octave, please make sure that your tests do not use Matlab-specific features.
* The structure of tests in `bindings/matlab/tests` uses [MOxUnit](https://github.com/MOxUnit/MOxUnit) a unit test framework for Matlab and Octave. Please see the MOxUnit documentation and existing tests for understanding the structure of the tests. As the tests are run by `GitHub Actions` also on Octave, please make sure that your tests do not use Matlab-specific features.
* Run matlab tests with `ctest -VV -R matlab` in the build directory, and check that they are running file.
* Commit the updated version of the bindings by adding everything inside the `bindings/matlab` directory, with commit message `[bindings] update matlab bindings`.

Expand Down

0 comments on commit 15ce240

Please sign in to comment.