From 7e45373e16f61ad63c668257af4a80ff7bcd30e7 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 27 Mar 2022 00:27:15 +0100 Subject: [PATCH] Add a simple workflow for updating HTML docs online Run doxygen and copy the generated files to docs.wxwidgets.org. Ignore the new workflow in all the existing CI ones, as changes to it shouldn't require rerunning them. See #19126. --- .github/workflows/ci.yml | 2 ++ .github/workflows/ci_cmake.yml | 2 ++ .github/workflows/ci_mac.yml | 2 ++ .github/workflows/ci_msw.yml | 2 ++ .github/workflows/ci_msw_cross.yml | 2 ++ .github/workflows/docs_update.yml | 40 ++++++++++++++++++++++++++++++ 6 files changed, 50 insertions(+) create mode 100644 .github/workflows/docs_update.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b2f17d597a..3cb28d90bf 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,6 +11,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_msw.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' @@ -31,6 +32,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_msw.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' diff --git a/.github/workflows/ci_cmake.yml b/.github/workflows/ci_cmake.yml index af5ac12cb0..4d850954aa 100644 --- a/.github/workflows/ci_cmake.yml +++ b/.github/workflows/ci_cmake.yml @@ -11,6 +11,7 @@ on: - '.github/workflows/ci_mac.yml' - '.github/workflows/ci_msw.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' @@ -31,6 +32,7 @@ on: - '.github/workflows/ci_mac.yml' - '.github/workflows/ci_msw.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' diff --git a/.github/workflows/ci_mac.yml b/.github/workflows/ci_mac.yml index 6fa6377e3e..282567d338 100644 --- a/.github/workflows/ci_mac.yml +++ b/.github/workflows/ci_mac.yml @@ -10,6 +10,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_msw.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' @@ -39,6 +40,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_msw.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' diff --git a/.github/workflows/ci_msw.yml b/.github/workflows/ci_msw.yml index 6c8f9a526b..ae9ed4dbf4 100644 --- a/.github/workflows/ci_msw.yml +++ b/.github/workflows/ci_msw.yml @@ -11,6 +11,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_mac.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' @@ -31,6 +32,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_mac.yml' - '.github/workflows/ci_msw_cross.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' diff --git a/.github/workflows/ci_msw_cross.yml b/.github/workflows/ci_msw_cross.yml index 674ab29684..05d3193f9a 100644 --- a/.github/workflows/ci_msw_cross.yml +++ b/.github/workflows/ci_msw_cross.yml @@ -11,6 +11,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_mac.yml' - '.github/workflows/ci_msw.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' @@ -33,6 +34,7 @@ on: - '.github/workflows/ci_cmake.yml' - '.github/workflows/ci_mac.yml' - '.github/workflows/ci_msw.yml' + - '.github/workflows/docs_update.yml' - 'build/tools/appveyor*.bat' - 'distrib/**' - 'docs/**' diff --git a/.github/workflows/docs_update.yml b/.github/workflows/docs_update.yml new file mode 100644 index 0000000000..e62fd66c10 --- /dev/null +++ b/.github/workflows/docs_update.yml @@ -0,0 +1,40 @@ +name: Update Documentation + +on: + push: + branches: + - master + workflow_dispatch: + + +jobs: + update: + runs-on: ubuntu-20.04 + name: Update Online Documentation + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Install doxygen + run: | + sudo apt-get -q -o=Dpkg::Use-Pty=0 -y install doxygen graphviz + + - name: Generate documentation + working-directory: docs/doxygen + run: | + ./regen.sh php + + - name: Upload + if: github.repository_owner == 'wxWidgets' + working-directory: docs/doxygen + env: + DOCS_WEBSITE_KEY: ${{secrets.DOCS_WEBSITE_KEY}} + DOCS_WEBSITE_SSH_CONFIG: ${{secrets.DOCS_WEBSITE_SSH_CONFIG}} + run: | + mkdir "$HOME/.ssh" + echo "$DOCS_WEBSITE_KEY" > "$HOME/.ssh/docs_website_key" + chmod 600 "$HOME/.ssh/docs_website_key" + echo "$DOCS_WEBSITE_SSH_CONFIG" > "$HOME/.ssh/config" + rsync --checksum --compress --delete --recursive --verbose + out/html/ wxdocs:public_html/latest/