-
Notifications
You must be signed in to change notification settings - Fork 6
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.
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
Adds inputs to README #140
Changes from 2 commits
6d5ea2c
5ee0351
599cdd8
4dd38e5
0c71dbf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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="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 | ||||||
## 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` | ||||||
|
||||||
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. | ||||||
|
||||||
See [action.yml](action.yml) | ||||||
## 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you say |
||||||
|
||||||
## Usage | ||||||
|
||||||
### Own repository | ||||||
|
||||||
```yaml | ||||||
on: | ||||||
# Allows you to run this workflow manually from the Actions tab | ||||||
workflow_dispatch: | ||||||
# 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 | ||||||
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 | ||||||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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: | ||||||
# 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' | ||||||
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 | ||||||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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 | ||||||
|
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