Skip to content

expose config flag in rsmetacheck action #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Anas-Elhounsri merged 2 commits into from
Jun 26, 2026
Merged

expose config flag in rsmetacheck action #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c549da
expose config flag in rsmetacheck action
francoto Jun 26, 2026
1306342
also expose the config-profile parameter and align README with actual…
francoto Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,17 @@ jobs:
uses: SoftwareUnderstanding/rs-metacheck-action@0.3.1
# optional arguments
with:
input: https://github.com/$GITHUB_REPOSITORY # if input is omited it will use GITHUB_REPOSITORY url
pitfalls_output: "./pitfalls_outputs"
verbose: "false"
# config: ".github/workflow/rsmetacheck.toml"
# config-profile: "prerelease" # use to set a profile defined in config. Overides the active_profile defined in rsmetacheck.toml
```

### Inputs

| Input | Description | Required | Default |
| ------------------- | ---------------------------------------------------------------------- | -------- | ------------------------- |
| `input` | One or more: GitHub/GitLab URLs, JSON files containing repositories. | **Yes** | |
| `input` | One or more: GitHub/GitLab URLs, JSON files containing repositories. | No | https://github.com/$GITHUB_REPOSITORY |
| `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` |
Expand All @@ -45,7 +46,8 @@ jobs:
| `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` |
| `config` | Specify the location of the `rsmetacheck.toml` to define the configuration. RSMetaCheck automatically detects a .rsmetacheck.toml (or rsmetacheck.toml) file at the working directory. | No | `rsmetacheck.toml` |
| `config` | Specify the location of the `rsmetacheck.toml` to define the configuration. RSMetaCheck automatically detects a .rsmetacheck.toml (or rsmetacheck.toml) file at the working directory. | No | `rsmetacheck.toml` |
| `config-profile` | Specify the profile to use. SHould be defined in the config file | No | |

### Outputs

Expand Down
6 changes: 6 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ inputs:
description: "Include both detected AND undetected pitfalls in the output JSON-LD."
required: false
default: "false"
config:
description: "Path to a TOML configuration file for RsMetaCheck."
required: false
config_profile:
description: "Profile name in the TOML configuration file to use for RsMetaCheck."
required: false

outputs:
has_pitfalls:
Expand Down
8 changes: 8 additions & 0 deletions entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ if [ -n "$INPUT_BRANCH" ]; then
CMD="$CMD --branch \"$INPUT_BRANCH\""
fi

if [ -n "$INPUT_CONFIG" ]; then
CMD="$CMD --config \"$INPUT_CONFIG_FILE\""
fi

if [ -n "$INPUT_CONFIG_PROFILE" ]; then
CMD="$CMD --config-profile \"$INPUT_CONFIG_PROFILE\""
fi

echo "Executing RsMetaCheck command:"
echo "$CMD"

Expand Down
Loading