Skip to content

Commit 1ff1847

Browse files
committed
Use GitHub actions to build and publish documentation site
1 parent bef2969 commit 1ff1847

2 files changed

Lines changed: 53 additions & 0 deletions

File tree

.github/workflows/build.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Build documentation and publish
2+
on: [push, pull_request]
3+
jobs:
4+
build:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- name: Install dependencies
8+
run: sudo apt-get install -y gcc-arm-none-eabi libnewlib-arm-none-eabi binutils-arm-none-eabi cmake ninja-build doxygen
9+
- uses: actions/checkout@v3
10+
- name: Generate build
11+
run: cmake -G Ninja -B build -S . --toolchain .github/workflows/cortex-m3.cmake -DORBCODE_LIBTRACE_BUILD_TEST=ON -DORBCODE_LIBTRACE_DOCS=ON
12+
- name: Build
13+
run: ninja -C build
14+
- name: Build documentation
15+
run: ninja -C build docs
16+
- uses: actions/upload-pages-artifact@v1
17+
with:
18+
path: build/docs/html
19+
deploy: # https://github.com/actions/deploy-pages
20+
needs: build
21+
if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
22+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
23+
permissions:
24+
pages: write # to deploy to Pages
25+
id-token: write # to verify the deployment originates from an appropriate source
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Deploy to GitHub Pages
32+
id: deployment
33+
uses: actions/deploy-pages@v1

.github/workflows/cortex-m3.cmake

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
set(CMAKE_CROSSCOMPILING 1)
2+
set(CMAKE_SYSTEM_PROCESSOR ARM)
3+
set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY)
4+
set(CMAKE_SYSTEM_NAME Generic)
5+
6+
set(COMPILER_PREFIX arm-none-eabi-)
7+
8+
find_program(CMAKE_C_COMPILER NAMES ${COMPILER_PREFIX}gcc)
9+
find_program(CMAKE_ASM_COMPILER NAMES ${COMPILER_PREFIX}gcc)
10+
find_program(CMAKE_CXX_COMPILER NAMES ${COMPILER_PREFIX}g++)
11+
12+
add_compile_options(
13+
-mcpu=cortex-m3
14+
-Wall
15+
-Werror
16+
)
17+
18+
add_link_options(
19+
-mcpu=cortex-m3
20+
)

0 commit comments

Comments
 (0)