xebialabs-community/xlr-fastlane-plugin

# XL Release Fastlane plugin v1.0.0

[![Build Status](https://travis-ci.org/xebialabs-community/xlr-fastlane-plugin.svg?branch=master)](https://travis-ci.org/xebialabs-community/xlr-fastlane-plugin)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3703a8ba14f04387a81a31baabef9563)](https://www.codacy.com/app/erasmussen39/xlr-fastlane-plugin?utm_source=github.com&utm_medium=referral&utm_content=xebialabs-community/xlr-fastlane-plugin&utm_campaign=Badge_Grade)
[![Maintainability](https://api.codeclimate.com/v1/badges/a58f7283ded34a1fa1e4/maintainability)](https://codeclimate.com/github/xebialabs-community/xlr-fastlane-plugin/maintainability)
[![License: MIT][xlr-fastlane-plugin-license-image]][xlr-fastlane-plugin-license-url]
[![Github All Releases][xlr-fastlane-plugin-downloads-image]]()

[xlr-fastlane-plugin-license-image]: https://img.shields.io/badge/License-MIT-yellow.svg
[xlr-fastlane-plugin-license-url]: https://opensource.org/licenses/MIT
[xlr-fastlane-plugin-downloads-image]: https://img.shields.io/github/downloads/xebialabs-community/xlr-fastlane-plugin/total.svg


## Preface ##

This document describes the functionality provided by the XL Release fastlane plugin.  fastlane is an open source platform aimed at simplifying Android and iOS deployment.  This plugin gives you the ability to checkout a GIT repository and invoke a fastlane 'lane' on a remote server.

See the **[XL Release Documentation](https://docs.xebialabs.com/xl-release/)** for background information on XL Release concepts.

See the **[fastlane.tools](https://docs.fastlane.tools/)** documentation for more information about fastlane.

## Overview ##

The XL Release Fastlane plugin enables you interact with fastlane.tools services.  The plugin supports the following tasks:

#### Task : Lane Task ####

![FastlaneTask](images/fastlane_task.png)

_Parameters_

Name | Description
------ | -------
Fastlane Host | Fastlane host defined in Settings > Shared Configuration
Git Project | GIT repository to checkout (optional).  If blank, the target directory is used "as is" without a code checkout. 
Branch | GIT branch used
Working Dir | Directory on the remote server to run fastlane.
Lane | The fastlane lane to invoke.
Options | Map of options passed to fastlane

#### Fastlane Host Configuration ####

![FastlaneHost](images/fastlane_host.png)

You will need to define one or more fastlane hosts.  For iOS apps, your a Mac host.  fastlane hosts are configured under Settings -> Shared Configuration.

## Requirements ##
* **XL Release** 7.x
* ssh running on the host computer
* fastlane installed on host computer
* <project directory>/fastlane/Fastfile with lane defined

## Installation ##

* Place the plugin JAR file into your `SERVER_HOME/plugins` directory.
* Restart the server