Adds inputs to README #140
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,62 +1,79 @@ | ||||||
| <p align="center"> | ||||||
| <a href="https://github.com/tortellini-tools/action/actions"><img alt="typescript-action status" src="https://github.com/tortellini-tools/action/workflows/build-test/badge.svg"></a> | ||||||
| <a href="https://github.com/tortellini-tools/action/actions"><img alt="linting-action status" src="https://github.com/tortellini-tools/action/workflows/linting/badge.svg"></a> | ||||||
| <a href="https://github.com/tortellini-tools/action/actions"><img alt="tortellini-action status" src="https://github.com/tortellini-tools/action/workflows/tortellini/badge.svg"></a> | ||||||
| </p> | ||||||
|
|
||||||
| # Tortellini GitHub Action | ||||||
|
|
||||||
| This action checks dependency licence issues using [ort](https://github.com/oss-review-toolkit/ort). | ||||||
|
|
||||||
| ## Inputs | ||||||
|
|
||||||
| ### `repositories` | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| ### `rules` | ||||||
|
|
||||||
| **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` | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| ## Outputs | ||||||
|
|
||||||
| No action outputs are defined for this actions. | ||||||
| However the action will write files to `.tortellini/out/` directory. | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. If you say |
||||||
|
|
||||||
| ## Usage | ||||||
|
|
||||||
| ### Own repository | ||||||
|
|
||||||
| ```yaml | ||||||
| on: | ||||||
| # Allows you to run this workflow manually from the Actions tab | ||||||
| workflow_dispatch: | ||||||
|
|
||||||
| jobs: | ||||||
| tortellini: | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - uses: actions/checkout@v2 | ||||||
| - uses: tortellini-tools/action@main | ||||||
| with: | ||||||
| curations: .tortellini.yml | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| rules: https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/rules.kts | ||||||
| classifications: https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/license-classifications.yml | ||||||
| ``` | ||||||
|
|
||||||
| ### Multiple repositories | ||||||
|
|
||||||
| ```yaml | ||||||
| on: | ||||||
| # Allows you to run this workflow manually from the Actions tab | ||||||
| workflow_dispatch: | ||||||
|
|
||||||
| jobs: | ||||||
| tortellini: | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - uses: actions/checkout@v2 | ||||||
| - run: | | ||||||
| echo 'https://github.com/tortellini-tools/action' > urls.txt | ||||||
| echo 'https://github.com/fair-software/howfairis' >> urls.txt | ||||||
| - uses: tortellini-tools/action@main | ||||||
| with: | ||||||
| repositories: 'urls.txt' | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| rules: https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/rules.kts | ||||||
| classifications: https://github.com/NLeSC/tortellini-on-rsd/raw/main/config/license-classifications.yml | ||||||
| ``` | ||||||
|
|
||||||
| ## Developer documentation | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not clear if this is required or optional. Can you add that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done