Adds inputs to README #140
Merged
Conversation
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
fdiblen
reviewed
Jun 14, 2021
README.md
Outdated
|
|
||
| ### `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. |
There was a problem hiding this comment.
Not clear if this is required or optional. Can you add that?
fdiblen
reviewed
Jun 14, 2021
README.md
Outdated
| ## 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
| However the action will write files to `.tortellini/out/` directory. | |
| The action will write files to `.tortellini/out/` directory by default. |
There was a problem hiding this comment.
If you say by default I expect that there is a way to changed which is not the case. See #85. I left out that part
fdiblen
reviewed
Jun 14, 2021
README.md
Outdated
| 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
| repositories: 'urls.txt' | |
| repositories: urls.txt |
fdiblen
reviewed
Jun 14, 2021
README.md
Outdated
| - uses: actions/checkout@v2 | ||
| - uses: tortellini-tools/action@main | ||
| with: | ||
| curations: .tortellini.yml |
There was a problem hiding this comment.
Suggested change
| curations: .tortellini.yml | |
| curations: curations.yml |
fdiblen
requested changes
Jun 14, 2021
|
Thanks for reviewing. Could you have another look? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Refs #117
Description
Refs: #issue_number
Before you get started
Checklist
This section should be filled in by the creator of this pull request to make sure the pull request is ready to review.
Instructions to review the pull request