Document example workflows with upload and also test them - Githubissues

tortellini-tools / action

GH action to check dependency licence issues using ort

https://github.com/marketplace/actions/tortellini-action

Apache License 2.0

3 stars 6 forks source link

Document example workflows with upload and also test them #136

Closed sverhoeven closed 3 years ago

sverhoeven commented 3 years ago

Refs #79

Description

Shows how to get the HTML files out of a workflow.
Make the workflows shown in README the same as those in .github/workflows/usage.yml.
The .github/workflows/usage.yml workflow no longer runs on each PR as .github/workflows/testing.yml tests the action much better. It can still be triggered manually see https://github.com/tortellini-tools/action/actions/runs/927859407 and will be run when main branch is changed.
- *

Before you get started

[x] I read and I followed contributing guidelines
[x] ☝ Create an issue to discuss what you are going to do

Checklist

This section should be filled in by the creator of this pull request to make sure the pull request is ready to review.

[ ] This pull request has a descriptive title
[ ] Code is written according to the code quality guidelines
[ ] Documentation if applicable is available
[ ] Tests run successfully
[ ] All checks below this pull request were successful

Instructions to review the pull request

sverhoeven commented 3 years ago

Thanks for the PR. I left a couple of comments. Apart from those, should we consider offering the two usage cases as separate workflow files? something like usage-current-repository.yml and usage-multiple-repositories.yml? (we can leave that for another day, just wanted to get your opinion)

Thanks for the comments, I addressed all of them. I like you proposal. We are showing complete workflows in the README having them separated in .github/workflows make sense. It will make it easier to keep them the same (README vs .github/workflows).