Update CI and instructions for antsibull-fileutils.

ansible-community · Aug 30, 2024 · baf285c · baf285c
1 parent 2af5637
commit baf285c
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 7 deletions.
diff --git a/.github/workflows/antsibull-build.yml b/.github/workflows/antsibull-build.yml
@@ -31,24 +31,28 @@ jobs:
             antsibull_changelog_ref: 0.24.0
             antsibull_core_ref: stable-2
             antsibull_docutils_ref: 1.0.0  # isn't used by antsibull-changelog 0.24.0
+            antsibull_fileutils_ref: main
           - name: Ansible 9
             options: '-e antsibull_ansible_version=9.99.0'
             python: '3.11'
             antsibull_changelog_ref: main
             antsibull_core_ref: stable-2
             antsibull_docutils_ref: main
+            antsibull_fileutils_ref: main
           - name: Ansible 10
             options: '-e antsibull_ansible_version=10.99.0'
             python: '3.12'
             antsibull_changelog_ref: main
             antsibull_core_ref: main
             antsibull_docutils_ref: main
+            antsibull_fileutils_ref: main
           - name: Ansible 11
             options: '-e antsibull_ansible_version=11.99.0'
             python: '3.12'
             antsibull_changelog_ref: main
             antsibull_core_ref: main
             antsibull_docutils_ref: main
+            antsibull_fileutils_ref: main
 
     steps:
       - name: Check out antsibull
@@ -77,6 +81,13 @@ jobs:
           path: antsibull-docutils
           ref: ${{ matrix.antsibull_docutils_ref }}
 
+      - name: Check out dependent project antsibull-fileutils
+        uses: actions/checkout@v4
+        with:
+          repository: ansible-community/antsibull-fileutils
+          path: antsibull-fileutils
+          ref: ${{ matrix.antsibull_fileutils_ref }}
+
       - name: Set up Python ${{ matrix.python }}
         uses: actions/setup-python@v5
         with:

diff --git a/.github/workflows/nox.yml b/.github/workflows/nox.yml
@@ -74,6 +74,11 @@ jobs:
         with:
           repository: ansible-community/antsibull-docutils
           path: antsibull-docutils
+      - name: Check out dependent project antsibull-fileutils
+        uses: actions/checkout@v4
+        with:
+          repository: ansible-community/antsibull-fileutils
+          path: antsibull-fileutils
       - name: Install extra packages
         if: "matrix.packages != ''"
         run: |

diff --git a/README.md b/README.md
@@ -48,19 +48,20 @@ and install the requirements needed to run the tests there.
 
 ---
 
-antsibull depends on the sister antsibull-core, antsibull-changelog, and
-antsibull-docutils projects.
+antsibull depends on the sister antsibull-core, antsibull-changelog,
+antsibull-docutils, and antsibull-fileutils projects.
 By default, `nox` will install development versions of these projects from
 Github.
-If you're hacking on antsibull-core or antsibull-changelog alongside antsibull,
+If you're hacking on antsibull-core, antsibull-changelog, antsibull-docutils and/or
+antsibull-fileutils alongside antsibull,
 nox will automatically install the projects from `../antsibull-core`,
-`../antsibull-changelog`, and `../antsibull-docutils` when running tests
-if those paths exist.
+`../antsibull-changelog`, `../antsibull-docutils`, and `../antsibull-fileutils`
+when running tests if those paths exist.
 You can change this behavior through the `OTHER_ANTSIBULL_MODE` env var:
 
 - `OTHER_ANTSIBULL_MODE=auto` — the default behavior described above
 - `OTHER_ANTSIBULL_MODE=local` — install the projects from `../antsibull-core`,
-  `../antsibull-changelog`, and `../antsibull-docutils`.
+  `../antsibull-changelog`, `../antsibull-docutils`, and `../antsibull-fileutils`.
   Fail if those paths don't exist.
 - `OTHER_ANTSIBULL_MODE=git` — install the projects from the Github main branch
 - `OTHER_ANTSIBULL_MODE=pypi` — install the latest version from PyPI

diff --git a/noxfile.py b/noxfile.py
@@ -43,7 +43,12 @@ def other_antsibull(
     if mode is None:
         mode = DEFAULT_MODE
     to_install: list[str | Path] = []
-    args = ("antsibull-core", "antsibull-changelog", "antsibull-docutils")
+    args = (
+        "antsibull-core",
+        "antsibull-changelog",
+        "antsibull-docutils",
+        "antsibull-fileutils",
+    )
     for project in args:
         path = Path("../", project)
         path_exists = path.is_dir()