<commit_before>Mozilla Release Engineering Services
====================================

A goal of *Release Engineering Services* is to *converge efforts* to
**develop**, **test**, **deploy**, **maintain**, and most importantly
**document** all services that *Release Engineering Team* is providing or
supporting.

    Currently supported platform is **Linux**.


Useful links
------------

:Code: https://github.com/mozilla-releng/services
:Issues: https://github.com/mozilla-releng/services/issues
:Documentation: https://docs.mozilla-releng.net


Repository structure
--------------------

- **src/**: folder with all the services
- **src/<service>**: folder with a <service> sources
- **lib/**: sources of libraries to help build services in **src/**
- **nix/**: all nix related
- **Makefile**: helper utilities


Quickstart
----------

Read :ref:`pre-requirements`.

Get code:

.. code-block:: bash

    % git clone https://github.com/mozilla-releng/services
    % cd services/
    % make  # will diplay help

Start **developing** a service:

.. code-block:: bash

    % make develop APP=<service>

Running service in **develop** mode (eg. restarting when source files changes):

.. code-block:: bash

    % make develop-run APP=<service>

Run **tests**:

.. code-block:: bash

    % make build-app APP=<service>




.. toctree::
    :maxdepth: 2

    prerequirements
    contributing
    service/clobberer 
<commit_msg>releng_docs: mention (auto)deployment in quickstart<commit_after>Mozilla Release Engineering Services
====================================

A goal of *Release Engineering Services* is to *converge efforts* to
**develop**, **test**, **deploy**, **maintain**, and most importantly
**document** all services that *Release Engineering Team* is providing or
supporting.

    Currently supported platform is **Linux**.


Useful links
------------

:Code: https://github.com/mozilla-releng/services
:Issues: https://github.com/mozilla-releng/services/issues
:Documentation: https://docs.mozilla-releng.net


Repository structure
--------------------

- **src/**: folder with all the services
- **src/<service>**: folder with a <service> sources
- **lib/**: sources of libraries to help build services in **src/**
- **nix/**: all nix related
- **Makefile**: helper utilities


Quickstart
----------

Read :ref:`pre-requirements`.

Get code:

.. code-block:: bash

    % git clone https://github.com/mozilla-releng/services
    % cd services/
    % make  # will diplay help

Start **developing** a service:

.. code-block:: bash

    % make develop APP=<service>

Running service in **develop** mode (eg. restarting when source files changes):

.. code-block:: bash

    % make develop-run APP=<service>

Run **tests**:

.. code-block:: bash

    % make build-app APP=<service>

Services get automatically **deployed** when code gets merged into ``staging``
or ``production``.


Contents
--------

.. toctree::
    :maxdepth: 2

    prerequirements
    contributing
    service/clobberer 

{'fraction_non_alphanumeric': 0.18429807052561545, 'fraction_numerical': 0.0006653359946773121, 'mean_word_length': 3.4351032448377583, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 8, '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': '4860900', 'n_tokens_mistral': 895, 'n_tokens_neox': 837, 'n_words': 279}