Skip to content

usage.md

Latest commit

 

History

History
87 lines (61 loc) · 1.61 KB

usage.md

File metadata and controls

87 lines (61 loc) · 1.61 KB
Raw

Usage

RSMetaCheck can be used as a local command-line tool or integrated into your CI/CD pipeline as a GitHub Action.

Command Line Interface

Analyze a Single Repository

poetry run rsmetacheck --input https://github.com/tidyverse/tidyverse

Analyze a Specific Branch

poetry run rsmetacheck --input https://github.com/tidyverse/tidyverse --branch develop

Analyze Multiple Repositories from a JSON File

Create a repositories.json file:

{
  "repositories": [
    "https://github.com/example/repo_1",
    "https://github.com/example/repo_2"
  ]
}

Run the analysis:

poetry run rsmetacheck --input repositories.json

Configure Analysis Rules

RsMetaCheck can load a root-level .rsmetacheck.toml file to customize analysis behavior.

ignore = ["W002"]
exclude_files = ["tmp_metadata.json"]

[parameters.P001]
ahead_significant_diff = 10

[profiles.prerelease]
ignore = []

[profiles.unstable]
ignore = ["W002", "P017"]

Use a profile:

poetry run rsmetacheck --input https://github.com/example/repo --config-profile unstable

Use an explicit config path:

poetry run rsmetacheck --input https://github.com/example/repo --config ./ci/rsmetacheck.toml

GitHub Action

You can integrate RSMetaCheck into your GitHub workflows:

name: RsMetaCheck

on: [push, pull_request]

jobs:
  check-metadata:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: SoftwareUnderstanding/RsMetaCheck@v0.2.1
        with:
          verbose: "false"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}