antsibull.yml

---
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later

# Run some antsibull 0.52.0 tests against the current development version of antsibull-core
# to make sure we don't accidentally break compatibility.

name: antsibull compatibility

on:
  push:
    branches:
      - main
      - stable-*
  pull_request:
    branches:
      - main
      - stable-*
  # Run once per week (Monday at 04:00 UTC)
  schedule:
    - cron: '0 4 * * 1'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Check out antsibull-core
        uses: actions/checkout@v4
        with:
          path: antsibull-core
          persist-credentials: false

      - name: Check out dependent project antsibull-fileutils
        uses: actions/checkout@v4
        with:
          repository: ansible-community/antsibull-fileutils
          path: antsibull-fileutils
          persist-credentials: false

      # antsibull 0.61.0 depends on antsibull-changelog >= 0.24.0 as well, so install 0.24.0 of that
      - name: Check out antsibull-changelog 0.24.0
        uses: actions/checkout@v4
        with:
          repository: ansible-community/antsibull-changelog
          ref: 0.24.0
          path: antsibull-changelog
          persist-credentials: false

      # nb: this is the first version of antsibull that declares support
      # for antsibull-core v3.
      - name: Check out antsibull 0.61.0
        uses: actions/checkout@v4
        with:
          repository: ansible-community/antsibull
          ref: 0.61.0
          path: antsibull
          persist-credentials: false

      - name: Patch antsibull noxfile.py
        run: |
          sed -i noxfile.py -e 's/args = ("antsibull-core", "antsibull-changelog")/args = ("antsibull-core", "antsibull-changelog", "antsibull-fileutils")/g'
        working-directory: antsibull

      - name: Patch antsibull pyproject.toml
        run: |
          sed -e 's/pyre-check/pyre-check <= 0.9.20,/' -i pyproject.toml
        working-directory: antsibull

      - name: Patch our pyproject.toml
        # Necessary for pyre...
        run: |
          sed -e 's/aiohttp/aiohttp < 3.10.0,/' -i pyproject.toml
        working-directory: antsibull-core

      - name: Set up Python 3.13
        id: python
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'

      - name: Install dependencies
        env:
          PYTHON: "${{ steps.python.outputs.python-path }}"
        run: |
          pipx install --python "${PYTHON}" nox
          python -m venv venv
          . ./venv/bin/activate
          python -m pip install . ../antsibull-core ../antsibull-changelog ../antsibull-fileutils
          ansible-galaxy collection install community.general
        working-directory: antsibull

      - name: Run type checkers
        run: |
          nox -e typing
        working-directory: antsibull

      - name: "Test building a release: Ansible 9 with ansible-core 2.16"
        run: |
          . ./venv/bin/activate
          ansible-playbook -vv playbooks/build-single-release.yaml -e antsibull_ansible_version=9.99.0 -e antsibull_build_file=ansible-9.build -e antsibull_data_dir="{{ antsibull_data_git_dir }}/9" -e antsibull_ansible_git_version=stable-2.16
        working-directory: antsibull
        env:
          # Make result better readable
          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml