Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pkriens committed Dec 13, 2021
1 parent 0d15471 commit 9755105
Showing 1 changed file with 32 additions and 18 deletions.
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,47 @@
# :gear: `setup-bnd` ![](https://github.com/pkriens/setup-bnd/workflows/Tests/badge.svg)
> A Github Action to install bnd
> A Github Action to install jpm
## About

This action will install the bnd jar so that it becomes available in the shell.
This action will install the jpm so that it becomes available in the shell. jpm can be used then to install
commands from maven central or other maven repositories.

This action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners, and will install and expose a specified version of the `bnd` CLI on the runner environment. This action requires the installation of java
This action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners, and will install and expose a specified version of the `jpm` CLI on the runner environment. This action requires the installation of java.

## Usage

Setup the `bnd` CLI:

```yaml
steps:
- uses: github-developer/setup-gh@v1
- uses: aQute-os/setup-jpm@v1
```

A specific version of the `gh` CLI can be installed:

```yaml
steps:
- uses: bndtools/setup-bnd@v1
with:
version:
1.1.0
```

## Inputs
The actions supports the following inputs:

- `version`: The version of `gh` to install, defaulting to `1.2.0`
## Example

The following example installs jpm and then runs jython

name: release

on:
push:
jobs:
build:
name: build on OpenJDK Linux
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Set up Java
uses: actions/setup-java@v1
with:
java-version: 1.8
- name: install jpm
uses: aQute-os/setup-jpm@v1.0.0
- name: Run jython
shell: bash
run: |
jpm install -n jython org.python:jython-standalone
jython

0 comments on commit 9755105

Please sign in to comment.