<commit_before>.. -*- rst -*-

.. highlightlang:: none

Travis CI
=========

This section describes about using groonga on `Travis CI
<http://travis-ci.org/>`_. Travis CI is a hosted continuous
integration service for the open source community.

You can use Travis CI for your open source software. This section only
describes about groonga related configuration. See `Travis CI:
Documentation <http://about.travis-ci.org/docs/>`_ about general
Travis CI.

Configuration
-------------

Travis CI is running on 32-bit Ubuntu 11.10. (See `Travis CI: About
Travis CI Environment
<http://about.travis-ci.org/docs/user/ci-environment/>`_.)  You can
use apt-line for Ubuntu 11.10 provided by groonga project to install
groonga on Travis CI.

You can custom build lifecycle by ``.travis.yml``. (See `Travis CI:
Conifugration your Travis CI build with .travis.yml
<http://about.travis-ci.org/docs/user/build-configuration/>`_.) You
can use ``before_install`` hook or ``install`` hook. You should use
``before_install`` if your software uses a language that is supported
by Travis CI such as Ruby. You should use ``install`` otherwise.

Add the following ``before_install`` configuration to ``.travisyml``::

  before_install:
    - echo "deb http://packages.groonga.org/ubuntu/ $(lsb_release --short --codename) universe" | sudo tee /etc/apt/sources.list.d/groonga.list
    - sudo apt-get update
    - sudo apt-get -y --allow-unauthenticated install groonga-keyring
    - sudo apt-get update
    - sudo apt-get -y install libgroonga-dev

If you need to use ``install`` hook instead of ``before_install``, you
just substitute ``before_install:`` with ``install:``.

With the above configuration, you can use groonga for your build.

Examples
--------

Here are open source softwares that use groonga on Travis CI:

  * `rroonga <http://groonga.rubyforge.org/#about-rroonga>`_ (Ruby bindings)

    * `rroonga on Travis CI <http://travis-ci.org/#!/ranguba/rroonga>`_
    * `.travis.yml for rroonga <https://github.com/ranguba/rroonga/blob/master/.travis.yml>`_

  * `nroonga <http://nroonga.github.com/>`_ (node.js bindings)

    * `nroonga on Travis CI <http://travis-ci.org/#!/nroonga/nroonga>`_
    * `.travis.yml for nroonga <https://github.com/nroonga/nroonga/blob/master/.travis.yml>`_

  * `logaling-command <http://logaling.github.com/>`_ (A glossary management command line tool)

    * `logaling-command on Travis CI <http://travis-ci.org/#!/logaling/logaling-command>`_
    * `.travis.yml for logaling-command <https://github.com/logaling/logaling-command/blob/master/.travis.yml>`_<commit_msg>doc: use setup script for Travis<commit_after>.. -*- rst -*-

.. highlightlang:: none

Travis CI
=========

This section describes about using groonga on `Travis CI
<http://travis-ci.org/>`_. Travis CI is a hosted continuous
integration service for the open source community.

You can use Travis CI for your open source software. This section only
describes about groonga related configuration. See `Travis CI:
Documentation <http://about.travis-ci.org/docs/>`_ about general
Travis CI.

Configuration
-------------

Travis CI is running on 32-bit Ubuntu 11.10. (See `Travis CI: About
Travis CI Environment
<http://about.travis-ci.org/docs/user/ci-environment/>`_.)  You can
use apt-line for Ubuntu 11.10 provided by groonga project to install
groonga on Travis CI.

You can custom build lifecycle by ``.travis.yml``. (See `Travis CI:
Conifugration your Travis CI build with .travis.yml
<http://about.travis-ci.org/docs/user/build-configuration/>`_.) You
can use ``before_install`` hook or ``install`` hook. You should use
``before_install`` if your software uses a language that is supported
by Travis CI such as Ruby. You should use ``install`` otherwise.

Add the following ``before_install`` configuration to ``.travisyml``::

  before_install:
    - curl https://raw.github.com/groonga/groonga/master/data/travis/setup.sh | sh

If you need to use ``install`` hook instead of ``before_install``, you
just substitute ``before_install:`` with ``install:``.

With the above configuration, you can use groonga for your build.

Examples
--------

Here are open source softwares that use groonga on Travis CI:

  * `rroonga <http://groonga.rubyforge.org/#about-rroonga>`_ (Ruby bindings)

    * `rroonga on Travis CI <http://travis-ci.org/#!/ranguba/rroonga>`_
    * `.travis.yml for rroonga <https://github.com/ranguba/rroonga/blob/master/.travis.yml>`_

  * `nroonga <http://nroonga.github.com/>`_ (node.js bindings)

    * `nroonga on Travis CI <http://travis-ci.org/#!/nroonga/nroonga>`_
    * `.travis.yml for nroonga <https://github.com/nroonga/nroonga/blob/master/.travis.yml>`_

  * `logaling-command <http://logaling.github.com/>`_ (A glossary management command line tool)

    * `logaling-command on Travis CI <http://travis-ci.org/#!/logaling/logaling-command>`_
    * `.travis.yml for logaling-command <https://github.com/logaling/logaling-command/blob/master/.travis.yml>`_
{'fraction_non_alphanumeric': 0.14199638481622817, 'fraction_numerical': 0.004016870857601928, 'mean_word_length': 3.8209099709583736, 'pattern_counts': {'":': 0, '<': 29, '<?xml version=': 0, '>': 29, 'https://': 7, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3501614', 'n_tokens_mistral': 1774, 'n_tokens_neox': 1657, 'n_words': 494}