Skip to content

Commit 2848e08

Browse files
committed
docs: add github pages job
Signed-off-by: Alexander Mohr <[email protected]>
1 parent cce511a commit 2848e08

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

.github/workflows/generate_documentation.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ on:
2323
permissions:
2424
contents: write
2525
actions: write
26+
pages: write
27+
id-token: write
2628

2729
jobs:
2830
build_documentation:
@@ -43,6 +45,11 @@ jobs:
4345
run: cargo doc --no-deps --all-features
4446
- name: Add index redirect
4547
run: echo '<meta http-equiv="refresh" content="0; url=dlt_tracing_appender">' > target/doc/index.html
48+
- name: Upload artifact for GitHub Pages
49+
#if: github.ref == 'refs/heads/main'
50+
uses: actions/upload-pages-artifact@v3
51+
with:
52+
path: target/doc
4653
- name: Create docs archive
4754
if: startsWith(github.ref, 'refs/tags/')
4855
run: |
@@ -53,3 +60,15 @@ jobs:
5360
uses: softprops/action-gh-release@v1
5461
with:
5562
files: rustdoc.tar.gz
63+
64+
deploy_pages:
65+
#if: github.ref == 'refs/heads/main'
66+
needs: build_documentation
67+
runs-on: ubuntu-latest
68+
environment:
69+
name: github-pages
70+
url: ${{ steps.deployment.outputs.page_url }}
71+
steps:
72+
- name: Deploy to GitHub Pages
73+
id: deployment
74+
uses: actions/deploy-pages@v4

dlt-sys/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
name = "dlt-sys"
1414
version = "0.1.0"
1515
edition.workspace = true
16-
publish = false
17-
description = "Wrapper around the C library libdlt to provide DLT logging capabilities for Rust applications"
16+
publish = true
17+
description = "FFI bindings to libdlt"
1818
homepage.workspace = true
1919
license.workspace = true
2020

0 commit comments

Comments
 (0)