Adding RsMetaCheck GitHub Action with Docker container and entrypoint script

Author: Anas-Elhounsri

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.11-slim
+
+# Install system dependencies
+RUN apt-get update && \
+    apt-get install -y git && \
+    rm -rf /var/lib/apt/lists/*
+
+# Install the RsMetaCheck tool from PyPI
+RUN pip install --no-cache-dir rsmetacheck
+
+# Copies the entrypoint script into the container
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+
+# Code file to execute when the docker container starts up
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,2 +1,47 @@
-# rs-metacheck-action
-Repository to maintain the research software metadata quality action
+# RsMetaCheck GitHub Action
+
+A GitHub Action to detect metadata pitfalls in software repositories using SoMEF.
+This action wraps the [RsMetaCheck](https://pypi.org/project/rsmetacheck/) Python tool.
+
+## Usage
+
+Create a workflow file in your repository, for example `.github/workflows/rsmetacheck.yml`:
+
+```yaml
+name: RsMetaCheck Validation
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  analyze-metadata:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Run RsMetaCheck
+        uses: your-github-username/rsmetacheck-action@v1
+        with:
+          # You can pass the repository URL automatically
+          input: "https://github.com/${{ github.repository }}"
+          pitfalls_output: "./pitfalls_outputs"
+          verbose: "false"
+```
+
+### Inputs
+
+| Input               | Description                                                            | Required | Default                   |
+| ------------------- | ---------------------------------------------------------------------- | -------- | ------------------------- |
+| `input`             | One or more: GitHub/GitLab URLs, JSON files containing repositories.   | **Yes**  |                           |
+| `skip_somef`        | Skip SoMEF execution and analyze existing SoMEF output files directly. | No       | `false`                   |
+| `pitfalls_output`   | Directory to store pitfall JSON-LD files.                              | No       | `./pitfalls_outputs`      |
+| `somef_output`      | Directory to store SoMEF output files.                                 | No       | `./somef_outputs`         |
+| `analysis_output`   | File path for summary results.                                         | No       | `./analysis_results.json` |
+| `threshold`         | SoMEF confidence threshold. Only used when running SoMEF.              | No       | `0.8`                     |
+| `branch`            | Branch of the repository to analyze.                                   | No       |                           |
+| `generate_codemeta` | Generate codemeta files for each repository.                           | No       | `false`                   |
+| `verbose`           | Include both detected AND undetected pitfalls in the output JSON-LD.   | No       | `false`                   |

action.yml

@@ -0,0 +1,46 @@
+name: "RsMetaCheck"
+description: "Detect metadata pitfalls in software repositories using SoMEF."
+author: "goblin"
+branding:
+  icon: "check-circle"
+  color: "blue"
+
+inputs:
+  input:
+    description: 'One or more: GitHub/GitLab URLs, JSON files containing repositories. (e.g. "https://github.com/owner/repo")'
+    required: true
+  skip_somef:
+    description: "Skip SoMEF execution and analyze existing SoMEF output files directly."
+    required: false
+    default: "false"
+  pitfalls_output:
+    description: "Directory to store pitfall JSON-LD files."
+    required: false
+    default: "./pitfalls_outputs"
+  somef_output:
+    description: "Directory to store SoMEF output files."
+    required: false
+    default: "./somef_outputs"
+  analysis_output:
+    description: "File path for summary results."
+    required: false
+    default: "./analysis_results.json"
+  threshold:
+    description: "SoMEF confidence threshold. Only used when running SoMEF."
+    required: false
+    default: "0.8"
+  branch:
+    description: "Branch of the repository to analyze. Overrides the default branch. Only used when running SoMEF."
+    required: false
+  generate_codemeta:
+    description: "Generate codemeta files for each repository. Only used when running SoMEF."
+    required: false
+    default: "false"
+  verbose:
+    description: "Include both detected AND undetected pitfalls in the output JSON-LD."
+    required: false
+    default: "false"
+
+runs:
+  using: "docker"
+  image: "Dockerfile"

entrypoint.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+set -e
+
+# Base command
+CMD="rsmetacheck"
+
+# Handle required input
+if [ -n "$INPUT_INPUT" ]; then
+  # Note: Do not quote $INPUT_INPUT here in case multiple URLs are passed as spaces
+  CMD="$CMD --input $INPUT_INPUT"
+else
+  echo "Error: The 'input' argument is required."
+  exit 1
+fi
+
+# Handle boolean flags
+if [ "$INPUT_SKIP_SOMEF" = "true" ]; then
+  CMD="$CMD --skip-somef"
+fi
+
+if [ "$INPUT_GENERATE_CODEMETA" = "true" ]; then
+  CMD="$CMD --generate-codemeta"
+fi
+
+if [ "$INPUT_VERBOSE" = "true" ]; then
+  CMD="$CMD --verbose"
+fi
+
+# Handle parameters with values
+if [ -n "$INPUT_PITFALLS_OUTPUT" ]; then
+  CMD="$CMD --pitfalls-output \"$INPUT_PITFALLS_OUTPUT\""
+fi
+
+if [ -n "$INPUT_SOMEF_OUTPUT" ]; then
+  CMD="$CMD --somef-output \"$INPUT_SOMEF_OUTPUT\""
+fi
+
+if [ -n "$INPUT_ANALYSIS_OUTPUT" ]; then
+  CMD="$CMD --analysis-output \"$INPUT_ANALYSIS_OUTPUT\""
+fi
+
+if [ -n "$INPUT_THRESHOLD" ]; then
+  CMD="$CMD --threshold \"$INPUT_THRESHOLD\""
+fi
+
+if [ -n "$INPUT_BRANCH" ]; then
+  CMD="$CMD --branch \"$INPUT_BRANCH\""
+fi
+
+echo "Executing RsMetaCheck command:"
+echo "$CMD"
+
+# Evaluate the command so spaces inside quotes are respected properly
+eval "$CMD"