diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 96f89e9..286e57b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,7 +1,7 @@ on: push: - branches-ignore: - - "gh-readonly-queue/**" + branches: + - 'main' pull_request: merge_group: workflow_dispatch: @@ -133,3 +133,63 @@ jobs: - name: Build run: just build + + build-docs: + name: Build the documentation + runs-on: ubuntu-latest + needs: [container] + container: + image: ${{ needs.container.outputs.container_name }} + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Set stm32l4r5zi config + run: just config load stm32l4r5zi_def --no-confirm + + - name: Generate docs + run: cargo doc --no-deps --workspace + + - name: Upload docs artifact + uses: actions/upload-artifact@v4 + with: + name: docs + path: target/doc + + deploy-docs: + name: Deploy the documentation online + runs-on: ubuntu-latest + needs: [build-docs] + if: github.ref == 'refs/heads/main' + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + contents: read + pages: write + id-token: write + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + sparse-checkout: website + + - name: Download docs + uses: actions/download-artifact@v4 + with: + name: docs + path: website/docs + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'website' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/website/images/osiris.png b/website/images/osiris.png new file mode 100644 index 0000000..62e7863 Binary files /dev/null and b/website/images/osiris.png differ diff --git a/website/index.html b/website/index.html new file mode 100644 index 0000000..278039c --- /dev/null +++ b/website/index.html @@ -0,0 +1,152 @@ + + + +
+ + +A real-time Operating System designed and verified to enable reliable software updates and operation for embedded systems.
+
+