From cf46dd1a1c5715640d6d9aae35c92c5e150e5969 Mon Sep 17 00:00:00 2001 From: Martin Corino Date: Sun, 14 Jan 2024 14:50:33 +0100 Subject: [PATCH] update all workflows and docs for doxygen version restriction removal --- .github/workflows/msw-master.yml | 12 ++++++------ .github/workflows/release.yml | 18 +++++++++--------- INSTALL.md | 2 +- README.md | 2 +- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/msw-master.yml b/.github/workflows/msw-master.yml index 778e102a..5b662387 100644 --- a/.github/workflows/msw-master.yml +++ b/.github/workflows/msw-master.yml @@ -62,22 +62,22 @@ jobs: id: cache-doxygen uses: actions/cache@v3 with: - path: doxygen-1.9.6.windows.x64.bin.zip + path: doxygen-1.10.0.windows.x64.bin.zip key: ${{ runner.os }}-doxygen - name: Download Doxygen tool if: steps.cache-doxygen.outputs.cache-hit != 'true' run: | - wget.exe https://www.doxygen.nl/files/doxygen-1.9.6.windows.x64.bin.zip - $hash = 'bdf1af97a733edd0a60fce2cf375c5c3' - if ((Get-FileHash doxygen-1.9.6.windows.x64.bin.zip -Algorithm MD5).Hash -ne $hash) { - del doxygen-1.9.6.windows.x64.bin.zip + wget.exe https://www.doxygen.nl/files/doxygen-1.10.0.windows.x64.bin.zip + $hash = '2135c1d5bdd6e067b3d0c40a4daac5d63d0fee1b3f4d6ef1e4f092db0d632d5b' + if ((Get-FileHash doxygen-1.10.0.windows.x64.bin.zip -Algorithm SHA256).Hash -ne $hash) { + del doxygen-1.10.0.windows.x64.bin.zip throw "Doxygen Hash doesn't match!" } - name: Install Doxygen package run: | - Expand-Archive -LiteralPath '.\doxygen-1.9.6.windows.x64.bin.zip' -DestinationPath $env:DOXYGEN_ROOT -Force + Expand-Archive -LiteralPath '.\doxygen-1.10.0.windows.x64.bin.zip' -DestinationPath $env:DOXYGEN_ROOT -Force echo "$env:DOXYGEN_ROOT" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - name: Display build environment diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a02ca4f6..ed768079 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -237,10 +237,9 @@ jobs: run: | brew install swig - - name: Install doxygen 1.9.6 + - name: Install doxygen run: | - brew tap mcorino/wxruby3 - brew install doxygen@1.9.6 + brew install doxygen - name: Show build environment run: | @@ -314,22 +313,23 @@ jobs: id: cache-doxygen uses: actions/cache@v3 with: - path: doxygen-1.9.6.windows.x64.bin.zip + path: doxygen-1.10.0.windows.x64.bin.zip key: ${{ runner.os }}-doxygen - name: Download Doxygen tool + if: steps.cache-doxygen.outputs.cache-hit != 'true' run: | - wget.exe https://www.doxygen.nl/files/doxygen-1.9.6.windows.x64.bin.zip - $hash = 'bdf1af97a733edd0a60fce2cf375c5c3' - if ((Get-FileHash doxygen-1.9.6.windows.x64.bin.zip -Algorithm MD5).Hash -ne $hash) { - del doxygen-1.9.6.windows.x64.bin.zip + wget.exe https://www.doxygen.nl/files/doxygen-1.10.0.windows.x64.bin.zip + $hash = '2135c1d5bdd6e067b3d0c40a4daac5d63d0fee1b3f4d6ef1e4f092db0d632d5b' + if ((Get-FileHash doxygen-1.10.0.windows.x64.bin.zip -Algorithm SHA256).Hash -ne $hash) { + del doxygen-1.10.0.windows.x64.bin.zip throw "Doxygen Hash doesn't match!" } - name: Install Doxygen package if: ${{ github.event_name != 'workflow_dispatch' }} run: | - Expand-Archive -LiteralPath '.\doxygen-1.9.6.windows.x64.bin.zip' -DestinationPath $env:DOXYGEN_ROOT -Force + Expand-Archive -LiteralPath '.\doxygen-1.10.0.windows.x64.bin.zip' -DestinationPath $env:DOXYGEN_ROOT -Force echo "$env:DOXYGEN_ROOT" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - name: Display build environment diff --git a/INSTALL.md b/INSTALL.md index 3921265f..7193b9bf 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -16,7 +16,7 @@ The minimal requirements for installing any source based setup (gem, source pack | C++ compiler
(incl. dev tools like `make`) | On linux a recent version of the GNU C++ compiler (with c++-14 support) needs to be installed
On Windows the RubyInstaller MSYS2-Devkit needs to be installed
On MacOS XCode with commandline tools needs to be installed via sudo xcode-select --install | | Git version control toolkit | | | SWIG >= 3.0.12 | On MacOS install Homebrew (https://brew.sh) and than brew install swig | -| Doxygen (>= 1.9.1, <= 1.9.6) | Doxygen > 1.9.6 has changes that cause problems with the wxWidgets doxygen files.
On MacOS: brew tap mcorino/wxruby3 and than `brew install doxygen@1.9.6` (default brew recipe installs 1.9.7) | +| Doxygen (>= 1.9.1) | On MacOS install Homebrew (https://brew.sh) and than brew install doxygen@ | | wxWidgets (>= 3.2) | See the wxWidgets installation section below. | The wxRuby3 build process requires `git` to clone a copy of the wxWidgets Github repository to extract the interface diff --git a/README.md b/README.md index 24824f33..acacae1d 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ To install the source-only gem the following software is required: | C++ compiler
(incl. dev tools like `make`) | On linux a recent version of the GNU C++ compiler (with c++-14 support) needs to be installed
On Windows the RubyInstaller MSYS2-Devkit needs to be installed
On MacOS XCode with commandline tools needs to be installed | | Git version control toolkit | | | SWIG >= 3.0.12 | On MacOS install with Homebrew | -| Doxygen (>= 1.9.1, <= 1.9.6) | Doxygen > 1.9.6 has changes that cause problems with the wxWidgets doxygen files. | +| Doxygen (>= 1.9.1) | On MacOS install with Homebrew | | wxWidgets >= 3.2 (*OPTIONAL*) | On Linux most distributions provide system installable (development) packages for wxWidgets providing a supported version.
Alternatively you can fairly easily install your own preferred version manually. | See the [INSTALL](INSTALL.md) document for more details.