A GitHub Action to detect metadata pitfalls in software repositories using SoMEF. This action wraps the RsMetaCheck Python tool.

Create a workflow file in your repository, for example .github/workflows/rsmetacheck.yml:

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@v6

      - name: Run RsMetaCheck
        uses: SoftwareUnderstanding/rsmetacheck-action@0.3.6
        # optional arguments
        with:
          pitfalls_output: "./pitfalls_outputs" 
          verbose: "false"
          branch: $GITHUB_REF # useful to run the analysis on the actual branch (default on main)
          # config: ".github/workflow/rsmetacheck.toml"
          # config_profile: "prerelease" # use to set a profile defined in config. Overides the active_profile defined in rsmetacheck.toml

This action automatically reports results in the GitHub Actions UI:

1. Step Summary — A rendered Markdown table appears at the bottom of the workflow run page, showing all detected pitfalls and warnings with descriptions, suggestions, and per-repository details.

2. Annotations — Detected pitfalls appear as ::error:: annotations (red markers) and warnings as ::warning:: annotations (yellow markers) at the top of the workflow run page. When triggered by a pull request, these also appear inline on the diff view.

3. Exit status — If any pitfalls or warnings are found, the action exits with code 1, causing the step to show as failed (red) in the workflow UI.

4. JSON-LD reports — Per-repository JSON-LD files remain on disk in the pitfalls_output directory. Add actions/upload-artifact@v4 to your workflow to make them downloadable as build artifacts.