docs: add github pages job

Signed-off-by: Alexander Mohr <[email protected]>

Author: alexmohr

.github/workflows/generate_documentation.yml

@@ -23,6 +23,8 @@ on:
 permissions:
   contents: write
   actions: write
+  pages: write
+  id-token: write
 
 jobs:
   build_documentation:
@@ -42,7 +44,12 @@ jobs:
       - name: Build documentation
         run: cargo doc --no-deps --all-features
       - name: Add index redirect
-        run: echo '<meta http-equiv="refresh" content="0; url=dlt_tracing_appender">' > target/doc/index.html
+        run: echo '<meta http-equiv="refresh" content="0; url=tracing_dlt">' > target/doc/index.html
+      - name: Upload artifact for GitHub Pages
+        #if: github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/doc
       - name: Create docs archive
         if: startsWith(github.ref, 'refs/tags/')
         run: |
@@ -53,3 +60,15 @@ jobs:
         uses: softprops/action-gh-release@v1
         with:
           files: rustdoc.tar.gz
+
+  deploy_pages:
+    #if: github.ref == 'refs/heads/main'
+    needs: build_documentation
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Cargo.toml

@@ -12,7 +12,7 @@
 [workspace.package]
 edition = "2024"
 license = "Apache-2.0"
-homepage = "https://github.com/eclipse-opensovd/classic-diagnostic-adapter"
+homepage = "https://github.com/eclipse-opensovd/dlt-tracing-lib"
 
 [workspace]
 resolver = "3"

dlt-rs/Cargo.toml

@@ -13,7 +13,7 @@
 name = "dlt-rs"
 version = "0.1.0"
 edition.workspace = true
-publish = false
+publish = true
 description = "Safe and idiomatic Rust wrapper for the C library libdlt to provide DLT logging capabilities for Rust applications"
 homepage.workspace = true
 license.workspace = true

dlt-sys/Cargo.toml

@@ -13,8 +13,8 @@
 name = "dlt-sys"
 version = "0.1.0"
 edition.workspace = true
-publish = false
-description = "Wrapper around the C library libdlt to provide DLT logging capabilities for Rust applications"
+publish = true
+description = "FFI bindings to libdlt"
 homepage.workspace = true
 license.workspace = true
 

tracing-dlt/Cargo.toml

@@ -13,7 +13,7 @@
 name = "tracing-dlt"
 version = "0.1.0"
 edition.workspace = true
-publish = false
+publish = true
 description = "DLT log sink for "
 homepage.workspace = true
 license.workspace = true