Making the reuse action easier to use

Instead of an undifferentiated pile of arguments, a more ordered set of options is available. The general arguments remain as an override.

Author: dkfellows

reuse/action.yml

@@ -23,6 +23,34 @@ inputs:
     description: "The branch to check out the reuse-tool from"
     required: false
     default: "main"
+  copyright-holder:
+    description: "The name of the copyright holder"
+    required: false
+    default: "University of Manchester"
+  license:
+    description: "The name of the license to apply"
+    required: false
+    default: "apache-2.0"
+  merge:
+    description: "Whether to merge copyrights"
+    required: false
+    default: "true"
+  fallback-dot-license:
+    description: "Whether to create a .license file as a fallback"
+    required: false
+    default: "true"
+  extra-formats-file:
+    description: "The name of the extra formats file"
+    required: false
+    default: ".extraformats"
+  ignore-file:
+    description: "The name of the ignore file"
+    required: false
+    default: ".licenseignore"
+  base-dir:
+    description: "The base directory to analyse and annotate"
+    required: false
+    default: "."
 runs:
   using: composite
   steps:
@@ -79,8 +107,23 @@ runs:
       key: ${{ steps.cache-venv.outputs.cache-primary-key }}
     if: steps.cache-venv.outputs.cache-hit != 'true'
 
+  - name: Set Up Arguments
+    id: args
+    shell: bash
+    env:
+      Arguments: ${{ inputs.args }}
+      Who: ${{ inputs.copyright-holder }}
+      License: ${{ inputs.license }}
+      Merge: ${{ inputs.merge }}
+      Fallback: ${{ inputs.fallback-dot-license }}
+      Extra: ${{ inputs.extra-formats-file }}
+      Ignore: ${{ inputs.ignore-file }}
+      Dir: ${{ inputs.base-dir }}
+    run: |
+      $GITHUB_ACTION_PATH/compose-args.bash
+
   - name: Run reuse
     shell: bash
     run: |
       source reuse-tool-venv/bin/activate
-      reuse ${{ inputs.args }}
+      reuse ${{ steps.args.outputs.args }}

reuse/compose-args.bash

@@ -0,0 +1,52 @@
+#!/usr/bin/bash
+
+# Copyright (c) 2025 The University of Manchester
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -e
+
+# If a full set of args supplied, skip generating them
+if [ -z "$Arguments" ]; then
+    # Basic arguments
+    Arguments="annotate --copyright \"$Who\" -license '$License' --recursive"
+
+    # Add if flag set
+    if [ "$Merge" == 'true' ]; then
+        Arguments="$Arguments --merge-copyrights"
+    fi
+
+    # Add if flag set
+    if [ "$Fallback" == 'true' ]; then
+        Arguments="$Arguments --fallback-dot-license"
+    fi
+
+    # Add if file exists
+    if [ -f "$Extra" ]; then
+        Arguments="$Arguments --extra-formats '$Extra'"
+    fi
+
+    # Add if file exists
+    if [ -f "$Ignore" ]; then
+        Arguments="$Arguments --ignore-file '$Ignore'"
+    fi
+
+    # Add if directory exists, else use fallback
+    if [ -d "$Dir" ]; then
+        Arguments="$Arguments '$Dir'"
+    else
+        Arguments="$Arguments ."
+    fi
+fi
+
+echo "args=$Arguments" #>>$GITHUB_OUTPUT