Skip to content

Commit 690df54

Browse files
authored
Merge pull request #3 from niwciu/develop
Pre Release PR 2
2 parents be0b8b9 + 86ddd0a commit 690df54

File tree

16 files changed

+3593
-266
lines changed

16 files changed

+3593
-266
lines changed

.github/workflows/jekyll-gh-pages.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
name: Project page and reports deploy
99

1010
on:
11-
1211
# pull_request:
1312
# types:
1413
# - closed
@@ -74,6 +73,13 @@ jobs:
7473
# with:
7574
# working-directory: './doc/'
7675

76+
# edit this step to meet your repo requirements
77+
- name: Generate _config.yml
78+
run: |
79+
echo "title: OBSERVER" > _config.yml
80+
echo "description: Embedded C Project documentation and reports" >> _config.yml
81+
echo "theme: minima" >> _config.yml
82+
7783
- name: Setup Pages
7884
uses: actions/configure-pages@v5
7985

@@ -109,4 +115,4 @@ jobs:
109115
steps:
110116
- name: Deploy to GitHub Pages
111117
id: deployment
112-
uses: actions/deploy-pages@v4
118+
uses: actions/deploy-pages@v4
Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build and deploy MkDocs site with reports
1+
name: Deploy MkDocs lib webpage
22

33
on:
44
pull_request:
@@ -18,23 +18,23 @@ concurrency:
1818
jobs:
1919
build:
2020
runs-on: ubuntu-latest
21-
# if: github.event.pull_request.merged == true
21+
if: github.event.pull_request.merged == true
2222
steps:
2323
- name: Checkout base branch
2424
uses: actions/checkout@v4
2525
with:
2626
ref: ${{ github.event.pull_request.base.ref }}
2727

28-
- name: Create Reports Folder
29-
run: mkdir -p docs/reports
28+
- name: Create docs Folder and subfolders
29+
run: mkdir -p docs/reports docs/examples
3030

3131
- name: Download CCR artifact
3232
uses: dawidd6/action-download-artifact@v2
3333
with:
3434
name: Code_Coverage_Report
3535
repo: ${{ github.repository }}
3636
workflow: CI_Pipeline.yml
37-
path: ./docs/reports/CCR
37+
path: ./docs/reports
3838
search_artifacts: true
3939

4040
- name: Download CCM artifact
@@ -43,9 +43,20 @@ jobs:
4343
name: Code_Complexity_Report
4444
repo: ${{ github.repository }}
4545
workflow: CI_Pipeline.yml
46-
path: ./docs/reports/CCM
46+
path: ./docs/reports
4747
search_artifacts: true
4848

49+
- name: Copy README.md to docs/
50+
run: cp README.md docs/README.md
51+
52+
- name: Copy examples README.md to docs/
53+
run: cp ./examples/README.md docs/examples/README.md
54+
55+
- name: Generate Doxygen html doc
56+
uses: mattnotmitt/doxygen-action@v1.9.5
57+
with:
58+
working-directory: './docs/doxygen'
59+
4960
- name: Setup Python
5061
uses: actions/setup-python@v5
5162
with:
@@ -67,7 +78,7 @@ jobs:
6778

6879
cleanup:
6980
runs-on: ubuntu-latest
70-
# if: github.event.pull_request.merged == true
81+
if: github.event.pull_request.merged == true
7182
permissions: write-all
7283
steps:
7384
- name: 🗑 Delete deployment

0 commit comments

Comments
 (0)