43 lines (42 loc) · 2.42 KB
/
ci-doxygen.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
####################################################################################################
## YAML file for github Actions that will perform project checking for adhering to doxygen ##
## documentation standards and to also deploy the generated HTML documentation to gh-pages ##
## ##
## ##
## Version Date Developer Comments ##
## ======= ========== ============== ============================================================ ##
## 1.0.0 2020-12-04 SV-Zanshin Initial coding ##
## ##
####################################################################################################
name: 'Doxygen'
####################################################################################################
## Action runs when committing (push), doing a pull request, or a workflow_dispatch ##
####################################################################################################
on:
push:
pull_request:
workflow_dispatch:
jobs:
doxygen:
name: 'Generate doxygen'
runs-on: ubuntu-latest
steps:
- name: 'Checkout the repository from github'
uses: actions/checkout@v2
- name: 'Checkout the "Zanduino/Common" repository from github'
uses: actions/checkout@v2
with:
repository: Zanduino/Common
path: Common
- name: 'Create doxygen html documentation'
env:
GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
##########################################################################################
## The following 5 lines need to be set here each project ##
##########################################################################################
PRETTYNAME: "BME280 Arduino Library"
PROJECT_NAME: "BME280"
PROJECT_NUMBER: "v1.0.4"
PROJECT_BRIEF: "Arduino Library for Bosch BME280 Temperature, Humidity, and Pressure"
PROJECT_LOGO: ""
run: bash ${GITHUB_WORKSPACE}/Common/Scripts/doxy_gen_and_deploy.sh