# gauge-java

**Repository Path**: foruforo/gauge-java

## Basic Information

- **Project Name**: gauge-java
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gauge-Java

[![Actions Status](https://github.com/getgauge/gauge-java/workflows/tests/badge.svg)](https://github.com/getgauge/gauge-java/actions)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.thoughtworks.gauge/gauge-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.thoughtworks.gauge/gauge-java)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)

This project adds java [language plugin](https://docs.gauge.org/plugins.html#language-reporting-plugins) for [gauge](http://getgauge.io).

## Getting started

### Pre-requisite

- [Install Gauge](https://docs.gauge.org/installing.html#installation)
- [Java](https://www.java.com/en/download/)

### Installation

```
gauge install java
```

### Create a gauge-java project

```
gauge init java
```

### Run tests

```
gauge run specs
```

### Alternate Installation options

#### Install specific version
* Installing specific version
```
gauge install java --version 0.6.5
```

#### Offline installation
* Download the plugin from [Releases](https://github.com/getgauge/gauge-java/releases)
```
gauge install java --file gauge-java-0.6.5-windows.x86_64.zip
```

#### Build from source

The plugin is authored in [Java](https://en.wikipedia.org/wiki/Java_(programming_language)).
Gauge is authored in golang. These are independent processes talking to each other over TCP on port GAUGE_INTERNAL_PORT (env variable) using [Protobuf](https://github.com/getgauge/gauge-proto).

##### Additional Requirements
Apart from [Gauge](https://gauge.org/index.html) and [Java](https://www.java.com/en/download/index.jsp) you will need

* [Maven](https://maven.apache.org/)
* [JQ](https://stedolan.github.io/jq/) (for unix)
##### Compiling

````
./build.sh | .\build.ps1 build
````

##### Installing

After compilation

````
./build.sh | .\build.ps1 forceinstall
````

##### Creating distributable

Note: Run after compiling

````
./build.sh | .\build.ps1 package
````


## Deployment

The deployments are managed via Github Actions. Whenever a PR is merged and contains label `ReleaseCandidate`, A deployment will occur with the current version and then the version will be bumped up.


## License

This program is licensed under:

Apache License, Version 2.0

## Copyright

Copyright 2016 ThoughtWorks, Inc.

## Acknowledgements

This project is supported by [YourKit Java Profiler](https://www.yourkit.com/java/profiler/index.jsp). YourKit supports open source projects with its full-featured Java Profiler, which is used by Gauge Team.

![Yourkit](https://www.yourkit.com/images/yklogo.png)