============================== Codeship-YAML |latest-version| ==============================

|codeship| |health| |python-support| |license| |gitter|

YAML configuration file support for Codeship_.

+------------+-------------+ | Syntax Compatibility | +============+=============+

• Travis CI | |travis-ci| |
• ------------+-------------+
• Shippable | |shippable| |
• ------------+-------------+

Background

Many continuous integration services support YAML configuration files in order to support the infrastructure as code_ paradigm. Codeship, though one of the most appealing platforms, is missing this feature. You have to add commands regarding setup, testing and deployment in your Codeship project settings. This has various disadvantages, but even though users are complaining_ Codeship is not planning to address the issue on its traditional build server infrastructure. (Only Codeship's new Docker-based infrastructure will finally make you more happy.)

Usage

Create a codeship.yml file in your repository at root level. The syntax is inspired by Travis CI_ and Shippable_, though only limited features are supported. Example:

.. code-block:: yaml

install: - pip install flake8 before_script: - touch codeship-yaml-was-here script: - flake8 after_success: - echo "Now we can deploy"

To make Codeship read and interpret your codeship.yml file, and execute the commands in it add the following lines in the Setup Commands text box at Codeship > Select Project... > (your project), Project Settings > Test Settings.

.. code-block:: bash

pip install codeship-yaml codeship-yaml

This will make codeship-yaml execute the commands you specified in the default sections in the following section order:

#. install #. before_script #. script #. after_success

More Control

If you want more control over which sections are executed you can specify the requested section as a parameter. For example, you could add the following commands into the below-mentioned text boxes of your Codeship project:

Project Settings > Test Settings > Setup Commands

.. code-block:: console

pip install codeship-yaml codeship-yaml install

Project Settings > Test Settings > Test Commands

.. code-block:: console

codeship-yaml before_script script

Project Settings > Deployment > (branch name)

.. code-block:: console

codeship-yaml after_success

Adding custom sections, other than the default ones, to your codeship.yml file is possible but discouraged (to avoid losing similarity with other build platforms). If you want an additional section, which is established on other platforms already, please consider placing a pull request_.

Python 3

The build image of Codeship Basic runs Python 2.7 by default_, but versions 3.4 through 3.7 are also installed. Codeship requires you to activate them using pyenv. Python is not Codeship's main expertise though, so expect a bumpy ride. Activating Python versions could be made easier. Sad story.

To make all Python versions available in parallel add the following command to the top of your Project Settings > Setup Commands on Codeship:

.. code-block:: console

pyenv global 2.7 3.4 3.5 3.6 3.7

Contribute

For development we use tox_, which handles both static code analysis and tests for all supported Python versions.

.. code-block:: console

$ pip install tox

After making your code changes don't forget to add tests, and simply run:

.. code-block:: bash

$ tox

When you place a pull request_ all tests are run on the build server infrastructure of Codeship, Travis CI and Shippable_ again. Please check if they all pass to ensure the syntax stays compatible across the different build infrastructures.

To remove all build files and folders including Python byte code you can run:

.. code-block:: bash

$ tox -e clean

Credits

This project is brought to you by Painless Software_, a best-practice consultancy in software development. Less pain, more fun.

A big, massive "Thank you!" to all contributors:

• Dave Allie <https://github.com/daveallie>__ (sectioning and coloring of command output)

.. |latest-version| image:: https://img.shields.io/pypi/v/codeship-yaml.svg :alt: Latest version on PyPI :target: https://pypi.python.org/pypi/codeship-yaml .. |codeship| image:: https://img.shields.io/codeship/7dea71d0-706e-0137-2928-164b86d3d83d/master.svg :alt: Build status :target: https://app.codeship.com/projects/7dea71d0-706e-0137-2928-164b86d3d83d .. |travis-ci| image:: https://img.shields.io/travis/painless-software/codeship-yaml/master.svg :alt: Build status :target: https://travis-ci.org/painless-software/codeship-yaml .. |shippable| image:: https://img.shields.io/shippable/5b3e90d7fbb95107000086b3/master.svg :alt: Build status :target: https://app.shippable.com/github/painless-software/codeship-yaml/dashboard .. |health| image:: https://img.shields.io/codacy/grade/5a3747dd8bcb4f16a57dd65904315733/master.svg :target: https://www.codacy.com/app/painless/codeship-yaml :alt: Code health .. |python-support| image:: https://img.shields.io/pypi/pyversions/codeship-yaml.svg :target: https://pypi.python.org/pypi/codeship-yaml :alt: Python versions .. |license| image:: https://img.shields.io/pypi/l/codeship-yaml.svg :alt: Software license :target: https://www.gnu.org/licenses/gpl-3.0.html .. |gitter| image:: https://badges.gitter.im/painless-software/codeship-yaml.svg :alt: Gitter chat room :target: https://gitter.im/painless-software/codeship-yaml

.. _Codeship: https://codeship.com/ .. _infrastructure as code: https://en.wikipedia.org/wiki/Infrastructure_as_Code .. _users are complaining: http://stackoverflow.com/questions/31772306/doesnt-codeship-support-yaml-configure-file .. _Travis CI: https://travis-ci.org/ .. _Shippable: https://shippable.com/ .. _Python 2.7 by default: https://documentation.codeship.com/basic/languages-frameworks/python/ .. _tox: https://tox.readthedocs.io/en/latest/ .. _pull request: https://github.com/painless-software/codeship-yaml/pulls .. _Painless Software: https://painless.software/