name: Docs / Validate metrics

permissions:
  contents: read

env:
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

on:
  pull_request:
    branches:
      - master
      - enterprise
    paths:
      - '**/*.cc'
      - 'scripts/metrics-config.yml'
      - 'scripts/get_description.py'
      - 'docs/_ext/scylladb_metrics.py'

jobs:
  validate-metrics:
    runs-on: ubuntu-latest
    name: Check metrics documentation coverage

    steps:
    - name: Checkout code
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        submodules: true

    - name: Set up Python
      uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
      with:
        python-version: '3.10'

    - name: Install dependencies
      run: pip install PyYAML

    - name: Validate metrics
      run: python3 scripts/get_description.py --validate -c scripts/metrics-config.yml