Merge pull request #27 from ucb-bar/upgrade-workflow

ADD: Upgrade workflow
ucb-bar · Dec 31, 2023 · 69ce6be · 69ce6be
2 parents f17af7f + e03ca1c
commit 69ce6be
Show file tree

Hide file tree

Showing 44 changed files with 6,200 additions and 712 deletions.
diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
@@ -0,0 +1,49 @@
+name: Build API Docs
+
+on:
+  push:
+    branches: [ "main" ]
+
+# Give the default GITHUB_TOKEN write permission to commit and push 
+# the docs files to the repository and allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Generate Documentation
+      uses: mattnotmitt/[email protected]
+      with:
+        working-directory: "."
+        doxyfile-path: "./docs/dependencies/Doxyfile"
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        # Upload docs repository
+        path: "./docs/"
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
diff --git a/.github/workflows/make-examplechip.yml → .github/workflows/make-examplechip.yaml b/.github/workflows/make-examplechip.yml → .github/workflows/make-examplechip.yaml
@@ -14,13 +14,13 @@ jobs:
       run:
         shell: bash -l {0}
 
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout
+      uses: actions/checkout@v4
       with:
-        submodules: 'true'
-    - run: echo $PATH
+        submodules: recursive
     - name: Set up toolchain
       run: echo "/scratch/tk/chipyard/.conda-env/riscv-tools/bin/" >> $GITHUB_PATH
-    - run: echo $PATH
-    - run: make
+    - name: Make
+      run: make
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Chipyard Baremetal-IDE
 
+![CI-status](https://img.shields.io/github/actions/workflow/status/ucb-bar/Baremetal-IDE/make-examplechip.yaml?branch=main&style=flat-square&label=CI&logo=githubactions&logoColor=fff) ![API-Docs-status](https://img.shields.io/github/actions/workflow/status/ucb-bar/Baremetal-IDE/build-docs.yaml?branch=main&style=flat-square&label=Docs&logo=googledocs&logoColor=fff)
+
 Baremetal-IDE is an all-in-one tool for baremetal-level C/C++ program developments. It is part of the Chipyard ecosystem.
 
 Baremetal-IDE features peripheral configuration, code generation, code compilation, and debugging tools for multiple RISC-V SoCs. With the board support package, user can use either the hardware-abstraction layer (HAL) functions to quickly configure and use the various supported peripheral devices, or can use the low-level (LL) macro definitions to generate code with minimal memory footprint and high performance. The modularity of the framework structure also allows fast integration of new SoCs. 

diff --git a/docs/.gitbook/assets/image (1).png b/docs/.gitbook/assets/image (1).png
diff --git a/docs/.gitbook/assets/image (2).png b/docs/.gitbook/assets/image (2).png
diff --git a/docs/.gitbook/assets/image (3).png b/docs/.gitbook/assets/image (3).png
diff --git a/docs/.gitbook/assets/image (4).png b/docs/.gitbook/assets/image (4).png
diff --git a/docs/.gitbook/assets/image (5).png b/docs/.gitbook/assets/image (5).png
diff --git a/docs/.gitbook/assets/image (6).png b/docs/.gitbook/assets/image (6).png
diff --git a/docs/.gitbook/assets/image (7).png b/docs/.gitbook/assets/image (7).png
diff --git a/docs/.gitbook/assets/image (8).png b/docs/.gitbook/assets/image (8).png
diff --git a/docs/.gitbook/assets/image.png b/docs/.gitbook/assets/image.png
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/adding-support-for-new-socs.md b/docs/adding-support-for-new-socs.md