Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hilmarf committed Dec 19, 2024
1 parent 8482a9a commit ed5e7d5
Showing 1 changed file with 15 additions and 17 deletions.
32 changes: 15 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,35 @@

[![REUSE status](https://api.reuse.software/badge/github.com/open-component-model/ocm-setup-action)](https://api.reuse.software/info/github.com/open-component-model/ocm-setup-action)

This GitHub Action installs a dedicated version of the OCM tool to be used
in further steps. For example, it could be used in a Makefile executed as
subsequenet step to build a project.
This GitHub Action installs a dedicated version of the ocm-cli to be used in further steps. For example, it could be used in a Makefile executed as subsequent step to build a project.

## Inputs

### `version`

**Optional** The tool version to install. By default the latest version is installed.
**Optional** The ocm-cli version to install. By default the latest version is installed.

### `repo`

**Optional** The repository of the tool to install. Default `"open-component-model/ocm"`.

## Outputs

## `ocm-path`

The installation path of the tool.
It is installed into a PATH folder. Therefore it can be directly be used, also.
**Optional** The repository of the ocm-cli to install. Default `"open-component-model/ocm"`.

## Example usage

```
uses: open-component-model/ocm-setup-action@main
with:
version: v0.3.0-rc.1
```yaml

jobs:
ocm-setup-action:
runs-on: ubuntu-latest
name: ocm-setup-action
steps:
- uses: open-component-model/ocm-setup-action@main
with:
version: v0.19.0
- run: ocm --version
```
## Licensing
Copyright 2022 SAP SE or an SAP affiliate company and Open Component Model contributors.
Copyright 2024 SAP SE or an SAP affiliate company and Open Component Model contributors.
Please see our [LICENSE](LICENSE) for copyright and license information.
Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/open-component-model/ocm-setup-action).

0 comments on commit ed5e7d5

Please sign in to comment.