aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorJoel Stanley <joel@jms.id.au>2022-03-08 12:15:43 +1030
committerCédric Le Goater <clg@kaod.org>2022-03-15 12:12:26 +0100
commit9adf45d48d188680c015e1a8608065dcf96c467c (patch)
tree9a38f5b93cc5b1a1d00f0ab90a7268260a4b3a42 /.github
parent3ffa501c4cfb58b6903014227247da1bdf79fd7e (diff)
downloadskiboot-9adf45d48d188680c015e1a8608065dcf96c467c.zip
skiboot-9adf45d48d188680c015e1a8608065dcf96c467c.tar.gz
skiboot-9adf45d48d188680c015e1a8608065dcf96c467c.tar.bz2
github: Add workflow to build and deploy docs
This builds the gcov coverage report and the skiboot docs on the Github hosted runner, without using a container. Remove the CROSS= definition from build-docs.sh to allow the makefile detect which cross compiler is installed, instead of hardcoding the non-le variant. This is a simplification from the previous docs build, which used the containers. However the containers have since been re-worked and no longer leave the build artifacts on the host system. The github action used for deploying seems to be the most commonly used: https://github.com/JamesIves/github-pages-deploy-action Signed-off-by: Joel Stanley <joel@jms.id.au> Signed-off-by: Cédric Le Goater <clg@kaod.org>
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/build-docs.yml30
1 files changed, 30 insertions, 0 deletions
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
new file mode 100644
index 0000000..242f200
--- /dev/null
+++ b/.github/workflows/build-docs.yml
@@ -0,0 +1,30 @@
+name: Generate and deploy documentation
+
+on:
+ push:
+ branches:
+ - master
+
+jobs:
+ docs-build-and-deploy:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Install apt dependencies
+ run: |
+ sudo apt install -qq build-essential gcc-powerpc64le-linux-gnu git lcov \
+ device-tree-compiler libssl-dev libmbedtls-dev \
+ python3-sphinx python3-recommonmark
+
+ - name: Generate docs and coverage report
+ run: ./opal-ci/build-docs.sh
+
+ - name: Deploy docs
+ uses: JamesIves/github-pages-deploy-action@v4.2.5
+ with:
+ branch: gh-pages
+ folder: doc/_build/ghpages