Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds inputs to README #140

Merged
merged 5 commits into from
Jun 14, 2021
Merged

Adds inputs to README #140

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6d5ea2c
Added inputs to README
sverhoeven Jun 14, 2021
5ee0351
Remove redundant text
sverhoeven Jun 14, 2021
599cdd8
Implement suggestions
sverhoeven Jun 14, 2021
4dd38e5
Merge remote-tracking branch 'origin/main' into 117-inputs-in-readme
sverhoeven Jun 14, 2021
0c71dbf
Better english
sverhoeven Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,32 @@

This action checks dependency license issues using [ort](https://github.com/oss-review-toolkit/ort).

<!-- ## Inputs
## Inputs

### `who-to-greet`
### `repositories`

**Required** The name of the person to greet. Default `"World"`.
A file containing list of GitHub repository urls. Format is a single url (`https://github.com/<owner>/<repo>`) on each line. If set then action will run check on each url and generate an overview HTML page.
If not set the action runs check on currently checked out repository (`.` directory).
By default the `repositories` input is not set.

## Outputs -->
### `rules`

## Usage
**Required** A file or URL containing [ort rules](https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md) to detect license violations. Default is [https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/rules.kts](https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/rules.kts).

### `classifications`

**Required** A file or URL containing classes for each license. For format see [ort documentation](https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-license-classifications-yml.md). Default is [https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/rules.kts](https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/rules.kts).

### `curations`

See [action.yml](action.yml)
A file or URL containing curations correct invalid or missing package metadata and set the concluded license for packages. See [ort documentation](https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-curations-yml.md) for format. If not set then action will not use any curations.

## Outputs

No action outputs are defined for this actions.
The action will write files to `.tortellini/out/` directory.

## Usage

### Own repository

Expand Down