| 1 | name: Docs Broken Link Check |
| 2 | |
| 3 | on: |
| 4 | pull_request: |
| 5 | paths: |
| 6 | - '**/*.md' |
| 7 | - '**/*.mdx' |
| 8 | - 'docs/**' |
| 9 | - '**/metadata.yaml' |
| 10 | - '**/taxonomy.yaml' |
| 11 | - 'integrations/**' |
| 12 | |
| 13 | concurrency: |
| 14 | group: ${{ github.workflow }}-${{ github.ref }} |
| 15 | cancel-in-progress: true |
| 16 | |
| 17 | jobs: |
| 18 | check-documentation: |
| 19 | runs-on: ubuntu-latest |
| 20 | steps: |
| 21 | - name: Checkout PR branch |
| 22 | uses: actions/checkout@v6 |
| 23 | with: |
| 24 | fetch-depth: 0 |
| 25 | path: netdata |
| 26 | |
| 27 | - name: Checkout netdata/learn repository |
| 28 | uses: actions/checkout@v6 |
| 29 | with: |
| 30 | repository: netdata/learn |
| 31 | path: learn |
| 32 | |
| 33 | - name: Init python env |
| 34 | uses: actions/setup-python@v6 |
| 35 | with: |
| 36 | python-version: "3.10" |
| 37 | |
| 38 | - name: Setup python dependencies |
| 39 | run: | |
| 40 | python3 -m venv ./venv |
| 41 | source ./venv/bin/activate |
| 42 | pip install -r learn/.learn_environment/ingest-requirements.txt |
| 43 | cd netdata && ./integrations/pip.sh |
| 44 | |
| 45 | - name: Generate Integrations |
| 46 | run: | |
| 47 | source ./venv/bin/activate |
| 48 | cd netdata && python3 integrations/gen_integrations.py |
| 49 | |
| 50 | - name: Check Collector Taxonomy |
| 51 | run: | |
| 52 | source ./venv/bin/activate |
| 53 | cd netdata && python3 integrations/check_collector_taxonomy.py --pr-diff "${{ github.event.pull_request.base.sha }}...${{ github.event.pull_request.head.sha }}" |
| 54 | |
| 55 | - name: Test Collector Taxonomy Tooling |
| 56 | run: | |
| 57 | source ./venv/bin/activate |
| 58 | cd netdata && python3 -m unittest integrations.tests.test_taxonomy |
| 59 | |
| 60 | - name: Generate Integrations Documentation |
| 61 | run: | |
| 62 | source ./venv/bin/activate |
| 63 | cd netdata && python3 integrations/gen_docs_integrations.py |
| 64 | |
| 65 | - name: Generate src/collectors/COLLECTORS.md |
| 66 | run: | |
| 67 | source ./venv/bin/activate |
| 68 | cd netdata && python3 integrations/gen_doc_collector_page.py |
| 69 | |
| 70 | - name: Generate src/collectors/SECRETS.md |
| 71 | run: | |
| 72 | source ./venv/bin/activate |
| 73 | cd netdata && python3 integrations/gen_doc_secrets_page.py |
| 74 | |
| 75 | - name: Run Ingest |
| 76 | working-directory: learn |
| 77 | run: | |
| 78 | source ../venv/bin/activate |
| 79 | echo "Running ingest with local netdata directory" |
| 80 | python ingest/ingest.py --local-repo "netdata:${{ github.workspace }}/netdata" --ignore-on-prem-repo --fail-links-netdata |