Skip to content

Commit 2f33fea

Browse files
authored
Merge pull request #9 from kenneth-jia/BuildArtifacts
Build artifacts for doc
2 parents 9efd7a0 + 6eb8bc8 commit 2f33fea

File tree

2 files changed

+51
-37
lines changed

2 files changed

+51
-37
lines changed

.github/workflows/on_pull_request.yml renamed to .github/workflows/ci_tests.yml

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: pull_request
1+
name: CI Tests
22

33
on: [push, pull_request]
44

@@ -509,39 +509,3 @@ jobs:
509509
cd $BUILD_SUB_DIR
510510
make -j${CPU_CORE_NUM} VERBOSE=1
511511
512-
build_doc:
513-
name: Generate Documents
514-
runs-on: ubuntu-latest
515-
env:
516-
BUILD_SUB_DIR: build/clang-doc
517-
steps:
518-
- uses: actions/checkout@v2
519-
- name: Install Dependencies
520-
run: |
521-
# Update the package list
522-
sudo apt update
523-
mkdir -p $BUILD_SUB_DIR
524-
cd $BUILD_SUB_DIR
525-
# 1. Install cmake
526-
sudo snap install cmake --classic
527-
export PATH=/snap/bin:$PATH
528-
# 2. Install python3-pip
529-
sudo apt install -y python3-pip
530-
pip3 install markdown
531-
# 3. Install doxygen
532-
sudo apt install -y doxygen
533-
- name: Config
534-
run: |
535-
cd $BUILD_SUB_DIR
536-
env CC=clang CXX=clang++ cmake ../.. -DBUILD_OPTION_GEN_DOC=ON -DCMAKE_CXX_FLAGS="-std=c++17"
537-
- name: Build
538-
run: |
539-
cd $BUILD_SUB_DIR
540-
make VERBOSE=1
541-
- name: Post Check
542-
run: |
543-
cd $BUILD_SUB_DIR
544-
ls -l doc/README.html
545-
ls -l doc/markdown/KafkaClientConfiguration.html
546-
ls -l doc/doxygen/annotated.html
547-

.github/workflows/gen_doc.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Generate Documents
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
build_doc:
11+
name: Build Doc
12+
runs-on: ubuntu-latest
13+
env:
14+
BUILD_SUB_DIR: build/clang-doc
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Install Dependencies
18+
run: |
19+
# Update the package list
20+
sudo apt update
21+
mkdir -p $BUILD_SUB_DIR
22+
cd $BUILD_SUB_DIR
23+
# 1. Install cmake
24+
sudo snap install cmake --classic
25+
export PATH=/snap/bin:$PATH
26+
# 2. Install python3-pip
27+
sudo apt install -y python3-pip
28+
pip3 install markdown
29+
# 3. Install doxygen
30+
sudo apt install -y doxygen
31+
- name: Config
32+
run: |
33+
cd $BUILD_SUB_DIR
34+
env CC=clang CXX=clang++ cmake ../.. -DBUILD_OPTION_GEN_DOC=ON -DCMAKE_CXX_FLAGS="-std=c++17"
35+
- name: Build
36+
run: |
37+
cd $BUILD_SUB_DIR
38+
make VERBOSE=1
39+
- name: Copy
40+
run: |
41+
mkdir doc-gen
42+
cp $BUILD_SUB_DIR/doc/README.html doc-gen
43+
cp -r $BUILD_SUB_DIR/doc/markdown doc-gen
44+
cp -r $BUILD_SUB_DIR/doc/doxygen doc-gen
45+
- name: Upload
46+
uses: actions/upload-artifact@v2
47+
with:
48+
name: document
49+
path: doc-gen
50+

0 commit comments

Comments
 (0)