Add static pages to Lobster (#82)

Make static pages into LOBSTER
bmw-software-engineering · Sep 30, 2024 · 982b9ba · 982b9ba
1 parent 7017e87
commit 982b9ba
Show file tree

Hide file tree

Showing 18 changed files with 72 additions and 4 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,60 @@
+name: Deploy static content to Pages
+
+on:
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_dev.txt
+      - name: Generate docs
+        run: |
+          make docs
+        env:
+          PYTHONPATH: "."
+      - name: Building code coverage report
+        run: |
+          make system-tests unit-tests
+          make coverage
+          mv htmlcov docs
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/Makefile b/Makefile
@@ -86,3 +86,7 @@ coverage:
 
 test-ci: system-tests unit-tests coverage
 	util/check_local_modifications.sh
+
+docs:
+	rm -rf docs
+	mkdir docs
diff --git a/README.md b/README.md
@@ -47,10 +47,10 @@ The following verification and miscellaneous frameworks are supported:
 
 ## Documentation
 
-* Writing [configuration files](docs/config_files.md) for LOBSTER.
+* Writing [configuration files](documentation/config_files.md) for LOBSTER.
 * It is easy to expand the languages and activities supported by
   LOBSTER by adding new tracing tools, as long as they create data in
-  the [common interchange format](docs/schemas.md) for LOBSTER.
+  the [common interchange format](documentation/schemas.md) for LOBSTER.
 
 (More to come...)
 
@@ -67,6 +67,10 @@ The individual packages that `bmw-lobster` depends on are:
 * `bmw-lobster-tool-json` (for activities in JSON)
 * `miss_hit` (for MATLAB/Octave code or Simulink models)
 
+### For LOBSTER developers
+
+* [Code Coverage Report](https://bmw-software-engineering.github.io/lobster/htmlcov/index.html)
+
 ## Planned inputs
 
 The following inputs are planned but not implemeted yet:

diff --git a/docs/advanced.dot → documentation/advanced.dot b/docs/advanced.dot → documentation/advanced.dot
diff --git a/docs/advanced.svg → documentation/advanced.svg b/docs/advanced.svg → documentation/advanced.svg
diff --git a/docs/architecture.dot → documentation/architecture.dot b/docs/architecture.dot → documentation/architecture.dot
diff --git a/docs/architecture.png → documentation/architecture.png b/docs/architecture.png → documentation/architecture.png
diff --git a/docs/cb_lobster_query.png → documentation/cb_lobster_query.png b/docs/cb_lobster_query.png → documentation/cb_lobster_query.png
diff --git a/docs/config_files.md → documentation/config_files.md b/docs/config_files.md → documentation/config_files.md
diff --git a/docs/example_report.html → documentation/example_report.html b/docs/example_report.html → documentation/example_report.html
diff --git a/docs/manual-lobster_codebeamer.md → documentation/manual-lobster_codebeamer.md b/docs/manual-lobster_codebeamer.md → documentation/manual-lobster_codebeamer.md
diff --git a/docs/manual-lobster_gtest.md → documentation/manual-lobster_gtest.md b/docs/manual-lobster_gtest.md → documentation/manual-lobster_gtest.md
diff --git a/docs/schemas.md → documentation/schemas.md b/docs/schemas.md → documentation/schemas.md
diff --git a/docs/simple.dot → documentation/simple.dot b/docs/simple.dot → documentation/simple.dot
diff --git a/docs/simple.svg → documentation/simple.svg b/docs/simple.svg → documentation/simple.svg
diff --git a/docs/user-manual.md → documentation/user-manual.md b/docs/user-manual.md → documentation/user-manual.md
diff --git a/integration-tests/projects/basic/Makefile b/integration-tests/projects/basic/Makefile
@@ -14,7 +14,7 @@ html_report.html: cppcode.lobster gtests.lobster mcode.lobster system-requiremen
 	@lobster-online-report
 	@cp report.lobster report.reference_output
 	@lobster-html-report
-	@cp lobster_report.html ../../../docs/example_report.html
+	@cp lobster_report.html ../../../documentation/example_report.html
 	@lobster-ci-report | tee ci_report.reference_output
 
 cppcode.lobster: foo.h foo.cpp

diff --git a/packages/lobster-tool-json/README.md b/packages/lobster-tool-json/README.md
@@ -106,7 +106,7 @@ Then you can use `--test-list=vectors` to identify the correct list.
 Note: This tool is pretty limited. For the obvious cases it works
 pretty well, but if you have a more complex test definition in JSON
 then you will need to write your own adaptor [using the documented
-schema](https://github.com/bmw-software-engineering/lobster/blob/main/docs/schemas.md).
+schema](https://github.com/bmw-software-engineering/lobster/blob/main/documentation/schemas.md).
 
 ## Copyright & License information