From 51e0b658664b7a757bf71c0eac5d15deef32336f Mon Sep 17 00:00:00 2001 From: Orion Poplawski Date: Fri, 8 Mar 2024 13:32:55 -0700 Subject: [PATCH 1/3] Update readthedocs config and add requirements --- .readthedocs.yml | 9 +++++++++ docs/requirements.rtd.txt | 1 + 2 files changed, 10 insertions(+) create mode 100644 docs/requirements.rtd.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index d45d468..c915002 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,9 +5,18 @@ # Required version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py # Optionally build your docs in additional formats such as PDF and ePub formats: all + +python: + install: + - requirements: docs/requirements.rtd.txt diff --git a/docs/requirements.rtd.txt b/docs/requirements.rtd.txt new file mode 100644 index 0000000..6cc8b5b --- /dev/null +++ b/docs/requirements.rtd.txt @@ -0,0 +1 @@ +sphinx_rtd_theme==1.0.0 From bb984903f8ad6b186def7d1d52a154cd7f2b2240 Mon Sep 17 00:00:00 2001 From: Orion Poplawski Date: Sat, 9 Mar 2024 10:11:09 -0700 Subject: [PATCH 2/3] Use checkout@v4 --- .github/workflows/changelog.yml | 2 +- .github/workflows/codeql-analysis.yml | 2 +- .github/workflows/increase-version.yml | 2 +- .github/workflows/packaging.yml | 14 +++++++------- .github/workflows/pypi.yml | 2 +- .github/workflows/qa.yml | 4 ++-- .github/workflows/testing.yml | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index f90462a..38ae246 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -17,7 +17,7 @@ jobs: python3-wheel python3-libvirt-python python3-netifaces - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Mark directory as safe for Git run: git config --global --add safe.directory /__w/koan/koan - name: Install towncrier diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 49e8670..64c1420 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -38,7 +38,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL diff --git a/.github/workflows/increase-version.yml b/.github/workflows/increase-version.yml index 7ea729c..68ff331 100644 --- a/.github/workflows/increase-version.yml +++ b/.github/workflows/increase-version.yml @@ -55,7 +55,7 @@ jobs: name: "Create Pull Request" runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Build version run: echo "new_version=${{ inputs.nextVersionMajor }}.${{ inputs.nextVersionMinor }}.${{ inputs.nextVersionPatch }}" >> $GITHUB_ENV - name: Replace version in koan/__init__.py diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml index 9945050..02b91ef 100644 --- a/.github/workflows/packaging.yml +++ b/.github/workflows/packaging.yml @@ -14,7 +14,7 @@ jobs: build-rockylinux-rpms: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Build a RockyLinux 8 Package shell: 'script -q -e -c "bash {0}"' run: | @@ -28,7 +28,7 @@ jobs: build-fedora-rpms: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Build a Fedora Package shell: 'script -q -e -c "bash {0}"' run: | @@ -42,7 +42,7 @@ jobs: build-opensuse-leap-rpms: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Install System dependencies run: sudo apt-get install -y rename - name: Build a openSUSE Leap 15.3 Package @@ -61,7 +61,7 @@ jobs: build-opensuse-tumbleweed-rpms: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Install System dependencies run: sudo apt-get install -y rename - name: Build a openSUSE Tumbleweed Package @@ -80,7 +80,7 @@ jobs: build-debian-debs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Build a Debian 10 Package shell: 'script -q -e -c "bash {0}"' run: | @@ -113,7 +113,7 @@ jobs: python3-Sphinx python3-netifaces tree - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Mark directory as safe for Git run: git config --global --add safe.directory /__w/koan/koan - name: Install dependencies @@ -141,7 +141,7 @@ jobs: build-wheel ] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/download-artifact@v3 name: Download all built artifacts with: diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml index 1529d97..944cefa 100644 --- a/.github/workflows/pypi.yml +++ b/.github/workflows/pypi.yml @@ -7,7 +7,7 @@ jobs: name: Build and publish Python distributions to TestPyPI runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Install package deps run: >- sudo apt-get install -y diff --git a/.github/workflows/qa.yml b/.github/workflows/qa.yml index 24d019d..c2c8cec 100644 --- a/.github/workflows/qa.yml +++ b/.github/workflows/qa.yml @@ -13,7 +13,7 @@ jobs: name: pyflakes formatter runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Install deps run: sudo apt-get install -y python3-pyflakes - name: Run pyflakes @@ -22,7 +22,7 @@ jobs: name: black formatter runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: psf/black@stable with: options: "--check --safe --verbose" diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index 2b7b6dd..0d4b004 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -15,7 +15,7 @@ jobs: steps: - name: Install pre reqs run: zypper -n in git tar - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Install package deps run: zypper -n in --no-recommends python3-devel python3-wheel python3-pip python3-libvirt-python python3-codecov gcc make - name: Install dependencies From e3ff32d81d42e24079c4bc1faed3b312217bf808 Mon Sep 17 00:00:00 2001 From: Orion Poplawski Date: Sat, 9 Mar 2024 17:03:05 -0700 Subject: [PATCH 3/3] Use pip3 install --break-system-packages due to python 3.12 change --- .github/workflows/packaging.yml | 2 +- .github/workflows/testing.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml index 02b91ef..c196d4c 100644 --- a/.github/workflows/packaging.yml +++ b/.github/workflows/packaging.yml @@ -117,7 +117,7 @@ jobs: - name: Mark directory as safe for Git run: git config --global --add safe.directory /__w/koan/koan - name: Install dependencies - run: pip3 install . + run: pip3 install --break-system-packages . - name: Build a binary wheel and a source tarball run: make release - name: Show tree diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index 0d4b004..d00ee0f 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -19,7 +19,7 @@ jobs: - name: Install package deps run: zypper -n in --no-recommends python3-devel python3-wheel python3-pip python3-libvirt-python python3-codecov gcc make - name: Install dependencies - run: pip3 install .[lint,test] + run: pip3 install --break-system-packages .[lint,test] - name: Run tests run: pytest --cov=./koan - name: Upload report to codecov