Skip to content

Commit ff3f6d2

Browse files
committed
.github: extract new sof-docs.yml from pull-request.yml
More progress towards trimming down pull-request.yml Important benefit and "secret" agenda: remove the constantly failing sof-docs from daily builds, which will make them green again. Green daily builds are important to quickly spot regressions like for instance #9797 Signed-off-by: Marc Herbert <marc.herbert@intel.com>
1 parent 6924b80 commit ff3f6d2

File tree

2 files changed

+57
-38
lines changed

2 files changed

+57
-38
lines changed

.github/workflows/pull-request.yml

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -63,44 +63,6 @@ jobs:
6363
ninja -C docbuild -v doc
6464

6565

66-
# This is unfortunately a mix of sof-docs/.github/ + the previous job
67-
# above, duplicating a bit of both: please keep in sync with both. We
68-
# build sof-docs here too because waiting for sof-docs CI to find
69-
# regressions introduced in sof.git is very time-consuming, see
70-
# example in
71-
# https://github.com/thesofproject/sof/pull/5731#issuecomment-1175630147
72-
sof-docs:
73-
runs-on: ubuntu-20.04 # sof-docs is still stuck to this for now
74-
75-
steps:
76-
- uses: actions/checkout@v4
77-
with:
78-
filter: 'tree:0'
79-
80-
- name: apt-get update
81-
run: sudo apt-get update
82-
83-
- name: apt-get install
84-
run: sudo apt-get -y install
85-
doxygen make default-jre graphviz cmake ninja-build
86-
87-
- name: doxygen
88-
run: cmake -GNinja -S doc/ -B doxybuild/ && ninja -C doxybuild/ -v doc
89-
90-
# Nested git clone, this is fine
91-
- name: clone sof-docs
92-
run: git clone https://github.com/thesofproject/sof-docs sof-docs/
93-
94-
- name: PATH += .local/bin
95-
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
96-
97-
- name: 'pip install -r sof-docs/scripts/requirements.txt'
98-
run: pip install -r sof-docs/scripts/requirements.txt
99-
100-
- name: build sof-docs
101-
run: make -C sof-docs/ html SOF_DOC_BUILD="$(pwd)"/doxybuild/
102-
103-
10466
# This is a bit redundant with the other jobs below and with the (much
10567
# faster!) installer[.yml] but it may differ in which platforms are
10668
# built. This makes sure platforms without any open-source toolchain

.github/workflows/sof-docs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
# yamllint disable-line rule:truthy
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
- 'stable-**'
8+
- '**-stable'
9+
pull_request:
10+
branches:
11+
- 'main'
12+
- 'stable-**'
13+
- '**-stable'
14+
15+
# Allows you to run this workflow manually from the Actions tab
16+
workflow_dispatch:
17+
# Allows to call this forkflow from other workflows
18+
workflow_call:
19+
20+
jobs:
21+
22+
# This is unfortunately a mix of sof-docs/.github/ + pull-request.yml#doxygen
23+
# duplicating a bit of both: please keep in sync with both. We
24+
# build sof-docs here too because waiting for sof-docs CI to find
25+
# regressions introduced in sof.git is very time-consuming, see
26+
# example in
27+
# https://github.com/thesofproject/sof/pull/5731#issuecomment-1175630147
28+
sof-docs:
29+
runs-on: ubuntu-20.04 # sof-docs is still stuck to this for now
30+
31+
steps:
32+
- uses: actions/checkout@v4
33+
with:
34+
filter: 'tree:0'
35+
36+
- name: apt-get update
37+
run: sudo apt-get update
38+
39+
- name: apt-get install
40+
run: sudo apt-get -y install
41+
doxygen make default-jre graphviz cmake ninja-build
42+
43+
- name: doxygen
44+
run: cmake -GNinja -S doc/ -B doxybuild/ && ninja -C doxybuild/ -v doc
45+
46+
# Nested git clone, this is fine
47+
- name: clone sof-docs
48+
run: git clone https://github.com/thesofproject/sof-docs sof-docs/
49+
50+
- name: PATH += .local/bin
51+
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
52+
53+
- name: 'pip install -r sof-docs/scripts/requirements.txt'
54+
run: pip install -r sof-docs/scripts/requirements.txt
55+
56+
- name: build sof-docs
57+
run: make -C sof-docs/ html SOF_DOC_BUILD="$(pwd)"/doxybuild/

0 commit comments

Comments
 (0)