name: Test Admonitions Generation
on:
  pull_request:
    paths:
      - src/telegram/**
      - docs/**
      - .github/workflows/docs-admonitions.yml
  push:
    branches:
      - master

permissions: {}

jobs:
  test-admonitions:
    name: Test Admonitions Generation
    runs-on: ${{matrix.os}}
    permissions:
      # for uploading artifacts
      actions: write
    strategy:
      matrix:
        python-version: ['3.12']
        os: [ubuntu-latest]
      fail-fast: False
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
        with:
          persist-credentials: false
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'
          cache-dependency-path: 'pyproject.toml'
      - name: Install dependencies
        run: |
          python -W ignore -m pip install --upgrade pip
          python -W ignore -m pip install .[all] --group all
      - name: Test autogeneration of admonitions
        run: pytest -v --tb=short tests/docs/admonition_inserter.py