Amebis/wxWidgets
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add a simple workflow for updating HTML docs online

Browse Source 
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.
This commit is contained in:
Vadim Zeitlin
2022-03-27 00:27:15 +01:00
parent 7769894304
commit 7e45373e16
6 changed files with 50 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@@ -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/**'

2
.github/workflows/ci_cmake.yml vendored
View File

@@ -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/**'

2
.github/workflows/ci_mac.yml vendored
View File

@@ -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/**'

2
.github/workflows/ci_msw.yml vendored
View File

@@ -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/**'

2
.github/workflows/ci_msw_cross.yml vendored
View File

@@ -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/**'

40
.github/workflows/docs_update.yml vendored Normal file
View File

@@ -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/