# henge-ruff-jenkins

> Ruff Jenkins Plugin for Henge

Latest version **0.3.6** (published 2017-12-12) · 0 weekly downloads

## Install

```sh
npm install henge-ruff-jenkins
pnpm add henge-ruff-jenkins
yarn add henge-ruff-jenkins
bun add henge-ruff-jenkins
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.6 |
| Published | 2017-12-12 |
| First published | 2016-08-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jerry-weng, topelinux, vilic |

## Links

- npm: https://www.npmjs.com/package/henge-ruff-jenkins
- npm.io page: https://npm.io/package/henge-ruff-jenkins

## Dependencies (1)

- [dotgit](https://npm.io/package/dotgit.md) ^0.1.1

## Recent versions

- 0.3.6 (latest) — 2017-12-12
- 0.3.5 — 2017-04-07
- 0.3.4 — 2017-04-07
- 0.3.3 — 2017-02-27
- 0.3.2 — 2017-01-09
- 0.3.1 — 2016-12-15
- 0.3.0 — 2016-12-14
- 0.2.7 — 2016-10-24
- 0.2.4 — 2016-08-15
- 0.2.3 — 2016-08-10
- 0.2.2 — 2016-08-10
- 0.2.1 — 2016-08-05
- 0.2.0 — 2016-08-04
- 0.1.2 — 2016-08-03
- 0.1.1 — 2016-08-01
- … 1 more at https://npm.io/package/henge-ruff-jenkins/versions

## README

# Ruff Jenkins Plugin for Henge

This plugin provides common variables and extensions for Henge on Ruff Jenkins.

## Variables

| Name | Description |
| --- | --- |
| `branch` | Current Git branch, defaults to environment variable `GIT_BRANCH`. For complete resolving logic, please check out the source code. |
| `jenkinsUrl` | Defaults to environment variable `JENKINS_URL`, fallbacks to `'http://jenkins.nanchao.org:8080/'`.
| `configUrl` | Base url or path under which the configuration files are stored. For example `"{configUrl}/embedded-platforms.json"`. |

### Local Configuration URL

If you want to use local configuration files, you may add, for example, a
`embedded-platforms.json` file under your project directory, and distribute
with `--local`:

```sh
henge dist --local
```

Then the `configUrl` variable will have the value `"."`.

If you want to provide reusable configurations, you can add them into a
directory and set environment variable `HENGE_RUFF_CONFIG_DIR` (which will
update the `configUrl` variable).

## Dependency Resolving

### Jenkins Artifact Resolving

This plugin adds the ability to resolve Jenkins dependencies to proper artifact
URLs.

Some extra options are provided:

- **job:** Jenkins job name.
- **singleNode?:** - Indicates whether the target multiplatform artifact is built
  on a single node (usually for embedded cross-compilation configuration)
  instead of several ones (usually for PCs).
- **branch?:** - Resolve this dependency to specific branch (one of `"master"`,
  `"release"` and `"develop"`).

### GitHub Resolving

GitHub resolving is also provided with following options:

- **github:** GitHub project path, in the form of `<username>/<project>`.
- **branch?:** - Branch to resolve, default to `"master"`.

## Default Artifact ID

This plugin also provides default artifact ID for artifacts, the ID could look
like:

- `"{name}-{version}"` (master or local)
- `"{name}-{version}-{platform}"` (master or local, multiplatform)
- `"{name}-{version}-SNAPSHOPT-{build}"` (other braches on Jenkins)
- `"{name}-{version}-{platform}-SNAPSHOPT-{build}"` (other braches on Jenkins,
  multiplatform)

## Build

To build this plugin:

```sh
npm install # Install dependencies
npm install henge # Do not need to save
npm run build # Compile TypeScript
```

Or you can use watch mode for compilation during development:

```sh
npm run build -- -w
```

---
_Source: https://npm.io/package/henge-ruff-jenkins · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._