From b0098097994d399c3a07e6081c6b45b0902325fd Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Fri, 11 Jun 2021 10:05:37 +0200
Subject: [PATCH 1/7] Document example workflows and make also test them

Refs #79
---
 .github/workflows/usage.yml | 22 ++++++------
 README.md                   | 67 +++++++++++++++++++++----------------
 2 files changed, 50 insertions(+), 39 deletions(-)

diff --git a/.github/workflows/usage.yml b/.github/workflows/usage.yml
index 4640c42..eb26a6e 100644
--- a/.github/workflows/usage.yml
+++ b/.github/workflows/usage.yml
@@ -1,7 +1,6 @@
 name: usage
 
 on: # run any PRs and main branch changes
-  pull_request:
   push:
     branches:
       - main
@@ -11,25 +10,26 @@ on: # run any PRs and main branch changes
   workflow_dispatch:
 
 jobs:
-
-  tortellini:
+  current-repository:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v2
+      - uses: tortellini-tools/action@main
+      - uses: actions/upload-artifact@v2
+        with:
+          name: tortellini-results
+          path: .tortellini/out
+
+  multiple-repositories:
+    runs-on: ubuntu-latest
+    steps:
       - 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
-      - run: tree -a -I '.git' -L 5 ./
-
       - uses: actions/upload-artifact@v2
         with:
           name: tortellini-results
-          path: |
-            .tortellini
-            !.tortellini/in
-            !.tortellini/out/**/analyzer-result.yml
-            !.tortellini/out/**/evaluation-result.yml
+          path: .tortellini/out
diff --git a/README.md b/README.md
index 498a866..a6d5279 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
 <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>
+  <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/workflows/usage.yml"><img alt="tortellini-action status" src="https://github.com/tortellini-tools/action/actions/workflows/usage.yml/badge.svg"></a>
 </p>
 
 # Tortellini GitHub Action
 
-This action checks dependency licence issues using [ort](https://github.com/oss-review-toolkit/ort).
+This action checks dependency license issues using [ort](https://github.com/oss-review-toolkit/ort).
 
 <!-- ## Inputs
 
@@ -21,44 +21,55 @@ This action checks dependency licence issues using [ort](https://github.com/oss-
 See [action.yml](action.yml)
 
 ### 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
+            - uses: actions/upload-artifact@v2
+              with:
+                  name: tortellini-results
+                  path: .tortellini/out
 ```
 
+Tortellini action will generate `.tortellini/out/scan-report-web-app.html` file.
+The HTML file can be downloaded from the [workflow page](https://github.com/actions/upload-artifact#where-does-the-upload-go) by using the GitHubs upload-artifact action.
+
 ### 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:
+            - 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
+            - uses: actions/upload-artifact@v2
+              with:
+                  name: tortellini-results
+                  path: .tortellini/out
 ```
 
+Tortellini action will generate `.tortellini/out/index.html` file and `.tortellini/out/<GitHub user or organization>/<GitHub repository>/scan-report-web-app.html` files.
+The HTML file can be downloaded from the [workflow page](https://github.com/actions/upload-artifact#where-does-the-upload-go) by using the GitHubs upload-artifact action.
+
+To view the HTML files directly you could upload the `.tortellini/out` folder to a web server like an AWS S3 bucket.
+
 ## Developer documentation
 
 See [README.dev.md](README.dev.md)

From 25c38075a4815a209b899fee3e98a866b0cc9c37 Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Fri, 11 Jun 2021 10:09:35 +0200
Subject: [PATCH 2/7] English

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a6d5279..3dd7063 100644
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@ jobs:
 ```
 
 Tortellini action will generate `.tortellini/out/index.html` file and `.tortellini/out/<GitHub user or organization>/<GitHub repository>/scan-report-web-app.html` files.
-The HTML file can be downloaded from the [workflow page](https://github.com/actions/upload-artifact#where-does-the-upload-go) by using the GitHubs upload-artifact action.
+The HTML files can be downloaded from [your workflow page](https://github.com/actions/upload-artifact#where-does-the-upload-go) by using GitHubs upload-artifact action.
 
 To view the HTML files directly you could upload the `.tortellini/out` folder to a web server like an AWS S3 bucket.
 

From 04d1836e2f60c42d6c35623845b9a17b729ef501 Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Fri, 11 Jun 2021 10:16:05 +0200
Subject: [PATCH 3/7] Dont use same artifact names

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3dd7063..420aac9 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ jobs:
             - uses: tortellini-tools/action@main
             - uses: actions/upload-artifact@v2
               with:
-                  name: tortellini-results
+                  name: tortellini-result
                   path: .tortellini/out
 ```
 

From e54a1d00b38d6df8cb2fcae33bba9c1062dfb5a4 Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Fri, 11 Jun 2021 10:27:53 +0200
Subject: [PATCH 4/7] Dont use same artifact names also in workflow

---
 .github/workflows/usage.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/usage.yml b/.github/workflows/usage.yml
index eb26a6e..ae4894a 100644
--- a/.github/workflows/usage.yml
+++ b/.github/workflows/usage.yml
@@ -17,7 +17,7 @@ jobs:
       - uses: tortellini-tools/action@main
       - uses: actions/upload-artifact@v2
         with:
-          name: tortellini-results
+          name: tortellini-result
           path: .tortellini/out
 
   multiple-repositories:

From 52505e5cb4407194622e2732448dc798a3bfe0f7 Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Mon, 14 Jun 2021 13:57:57 +0200
Subject: [PATCH 5/7] Added name to urls.txt step + rephrase workflow page +
 replace hosting with unzipping/webbrowser

---
 .github/workflows/usage.yml | 3 ++-
 README.md                   | 8 ++++----
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/usage.yml b/.github/workflows/usage.yml
index ae4894a..b79cb3c 100644
--- a/.github/workflows/usage.yml
+++ b/.github/workflows/usage.yml
@@ -23,7 +23,8 @@ jobs:
   multiple-repositories:
     runs-on: ubuntu-latest
     steps:
-      - run: |
+      - name: Create list of GitHub urls to perform check on
+        run: |
           echo 'https://github.com/tortellini-tools/action' > urls.txt
           echo 'https://github.com/fair-software/howfairis' >> urls.txt
       - uses: tortellini-tools/action@main
diff --git a/README.md b/README.md
index 420aac9..a99c7ad 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@ jobs:
 ```
 
 Tortellini action will generate `.tortellini/out/scan-report-web-app.html` file.
-The HTML file can be downloaded from the [workflow page](https://github.com/actions/upload-artifact#where-does-the-upload-go) by using the GitHubs upload-artifact action.
+The HTML file can be downloaded from the workflow page (see the documentation of the [`Upload a Build Artifact` GitHub action](https://github.com/actions/upload-artifact#where-does-the-upload-go)). After unzipping the `scan-report-web-app.html` can be viewed in a web browser.
 
 ### Multiple repositories
 
@@ -53,7 +53,8 @@ jobs:
     tortellini:
         runs-on: ubuntu-latest
         steps:
-            - run: |
+            - name: Create list of GitHub urls to perform check on
+              run: |
                   echo 'https://github.com/tortellini-tools/action' > urls.txt
                   echo 'https://github.com/fair-software/howfairis' >> urls.txt
             - uses: tortellini-tools/action@main
@@ -66,9 +67,8 @@ jobs:
 ```
 
 Tortellini action will generate `.tortellini/out/index.html` file and `.tortellini/out/<GitHub user or organization>/<GitHub repository>/scan-report-web-app.html` files.
-The HTML files can be downloaded from [your workflow page](https://github.com/actions/upload-artifact#where-does-the-upload-go) by using GitHubs upload-artifact action.
 
-To view the HTML files directly you could upload the `.tortellini/out` folder to a web server like an AWS S3 bucket.
+The HTML files can be downloaded from the workflow page (see the documentation of the [`Upload a Build Artifact` GitHub action](https://github.com/actions/upload-artifact#where-does-the-upload-go)). After unzipping the `index.html` can be viewed in a web browser.
 
 ## Developer documentation
 

From d115db73b2c3082b86409b10019fa500e643947a Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Mon, 14 Jun 2021 14:10:58 +0200
Subject: [PATCH 6/7] Split usage workflow in 2

---
 .../workflows/usage-current-repository.yml    | 21 +++++++++++++++++++
 ...ge.yml => usage-multiple-repositories.yml} | 14 ++-----------
 README.dev.md                                 | 15 ++++++-------
 3 files changed, 31 insertions(+), 19 deletions(-)
 create mode 100644 .github/workflows/usage-current-repository.yml
 rename .github/workflows/{usage.yml => usage-multiple-repositories.yml} (69%)

diff --git a/.github/workflows/usage-current-repository.yml b/.github/workflows/usage-current-repository.yml
new file mode 100644
index 0000000..27526b5
--- /dev/null
+++ b/.github/workflows/usage-current-repository.yml
@@ -0,0 +1,21 @@
+name: usage on current repository
+
+on: # run any PRs and main branch changes
+  push:
+    branches:
+      - main
+      - 'releases/*'
+
+  # 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
+      - uses: actions/upload-artifact@v2
+        with:
+          name: tortellini-result
+          path: .tortellini/out
diff --git a/.github/workflows/usage.yml b/.github/workflows/usage-multiple-repositories.yml
similarity index 69%
rename from .github/workflows/usage.yml
rename to .github/workflows/usage-multiple-repositories.yml
index b79cb3c..952b459 100644
--- a/.github/workflows/usage.yml
+++ b/.github/workflows/usage-multiple-repositories.yml
@@ -1,4 +1,4 @@
-name: usage
+name: usage on multiple repositories
 
 on: # run any PRs and main branch changes
   push:
@@ -10,17 +10,7 @@ on: # run any PRs and main branch changes
   workflow_dispatch:
 
 jobs:
-  current-repository:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: tortellini-tools/action@main
-      - uses: actions/upload-artifact@v2
-        with:
-          name: tortellini-result
-          path: .tortellini/out
-
-  multiple-repositories:
+  tortellini:
     runs-on: ubuntu-latest
     steps:
       - name: Create list of GitHub urls to perform check on
diff --git a/README.dev.md b/README.dev.md
index 838a655..44f6106 100644
--- a/README.dev.md
+++ b/README.dev.md
@@ -113,7 +113,7 @@ The analyses will be stored in the directories
 
 1. Update the citation metadata in `CITATION.cff`. Afterwards, follow the instructions from the `cffconvert` workfow to sync the information in `.zenodo.json` with that in `CITATION.cff`
 1. Actions are run from GitHub repos so we need to generate the Javascript files in the `dist` folder and push the results:
-    
+
     ```bash
     $ cd $(mktemp --directory --tmpdir tortellini-prep-release.XXXXXX)
     $ git clone https://github.com/tortellini-tools/action .
@@ -123,17 +123,18 @@ The analyses will be stored in the directories
     $ git commit --message "prod dependencies"
     $ git push origin main
     ```
+
 1. Next, check if the top three actions on the [action page](https://github.com/tortellini-tools/action/actions?query=branch%3Amain+workflow%3Atortellini+event%3Apush) are green.
-1. Create a release on the Github page via 
-[Create a new release](https://github.com/tortellini-tools/action/releases/new).
+1. Create a release on the Github page via
+   [Create a new release](https://github.com/tortellini-tools/action/releases/new).
 1. On the new release page, for `Tag version` use `v` and the next version number, for example `v3`.
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-for more information.
+   See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
+   for more information.
 
 Your action is now published! :rocket:
 
 Check if the new version has been published on the [Github Marketplace](https://github.com/marketplace/actions/tortellini-action).
 
-You can now validate the action by going to 
-[this workflow](https://github.com/tortellini-tools/action/actions/workflows/usage.yml)
+You can now validate the action by going to
+[this workflow](https://github.com/tortellini-tools/action/actions/workflows/usage-current-repository.yml) and [this workflow]([this workflow](https://github.com/tortellini-tools/action/actions/workflows/usage-multiple-repositories.yml))
 and then clicking on the button `Run workflow`.

From be68520555924a94b5362bf59a38fbc140566ff8 Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Mon, 14 Jun 2021 14:14:36 +0200
Subject: [PATCH 7/7] Correct badges

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a99c7ad..b61bb8d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 <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/workflows/usage.yml"><img alt="tortellini-action status" src="https://github.com/tortellini-tools/action/actions/workflows/usage.yml/badge.svg"></a>
+  <a href="https://github.com/tortellini-tools/action/actions/workflows/usage-current-repository.yml"><img alt="tortellini-action status" src="https://github.com/tortellini-tools/action/actions/workflows/usage-current-repository.yml/badge.svg"></a>
+  <a href="https://github.com/tortellini-tools/action/actions/workflows/usage-multiple-repositories.yml"><img alt="tortellini-action status" src="https://github.com/tortellini-tools/action/actions/workflows/usage-multiple-repositories.yml/badge.svg"></a>
 </p>
 
 # Tortellini GitHub Action