Added github-pages (#2)

* Added github-pages
dnv-opensource · May 16, 2024 · 59045b9 · 59045b9
1 parent 7773afb
commit 59045b9
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 14 deletions.
diff --git a/.github/workflows/github-ci.yml b/.github/workflows/github-ci.yml
@@ -32,7 +32,7 @@ jobs:
         - name: Setting variables
           run: |
             if ("${{ matrix.TYPE }}" -like "Debug") { echo "SKIP_TEST=True" >> "$GITHUB_ENV" }
-            
+
         - name: Conan build
           run: |
             conan config install "${{ env.conan_config }}" --type git -sf profiles -tf profiles
@@ -56,8 +56,10 @@ jobs:
       runs-on: ubuntu-22.04
       strategy:
           matrix:
-            TYPE: [Release, Debug]
+            TYPE: [Debug, Release]
             PROFILE: ["gcc12"]
+      env:
+        TARGET: "${{ github.job }}-${{ matrix.TYPE }}"
       steps:
         - uses: actions/checkout@v4
 
@@ -66,7 +68,7 @@ jobs:
           with:
             path: |
               ~/.conan2
-            key: ${{ runner.os }}-${{ matrix.TYPE }}-dds-fmu
+            key: ${{ env.TARGET }}-dds-fmu
 
         - name: Install Conan
           id: conan
@@ -93,13 +95,20 @@ jobs:
         - name: Upload artifacts
           uses: actions/upload-artifact@v4
           with:
-            name: "${{ github.job }}-${{ matrix.TYPE }}"
+            name: "${{ env.TARGET }}"
             path: | 
               build/${{ matrix.TYPE }}/fmus/*
-              public/*
               testoutput/*.xml
             retention-days: 1
 
+        - name: Upload pages artifact
+          if: env.TARGET == 'linux-Release'
+          uses: actions/upload-artifact@v4
+          with:
+            name: github-pages
+            path: public
+
+
     fmu:
       needs: [linux, windows]
       runs-on: ubuntu-22.04
@@ -121,9 +130,9 @@ jobs:
             mkdir tmp_${{ matrix.TYPE }} && cd tmp_${{ matrix.TYPE }}
             the_fmus=(../fmus/**/*${{ matrix.TYPE }}.fmu)
             fmu_count=${#the_fmus[@]}
-            for (( i=0; i<$fmu_count; i++ )); do 
-              an_fmu="${the_fmus[$i]}" 
-              cmake -E tar xf $an_fmu 
+            for (( i=0; i<$fmu_count; i++ )); do
+              an_fmu="${the_fmus[$i]}"
+              cmake -E tar xf $an_fmu
             done
             mkdir ../combined_fmus
             cmake -E tar cf ../combined_fmus/$FMU_NAME-${{ matrix.TYPE }}.fmu --format=zip .
@@ -151,3 +160,22 @@ jobs:
           uses: softprops/action-gh-release@v2
           with:
             files: "${{ github.event.repository.name }}.fmu"
+
+    docs:
+      if: ${{ startsWith(github.ref, 'refs/tags/') }}
+      needs: [fmu]
+      runs-on: ubuntu-22.04
+      steps:
+        - name: Download artifacts
+          uses: actions/download-artifact@v4
+          with:
+            name: github-pages
+            path: public/
+        - name: Publish documentation
+          uses: peaceiris/actions-gh-pages@v4
+          with:
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            force_orphan: true
+
+
+
diff --git a/README.org b/README.org
@@ -1,16 +1,15 @@
-[[https://co-simulation.pages.sintef.no/dds-fmu][https://img.shields.io/badge/Docs-HTML-blue.svg?style=flat-square&logo=googledocs&logoColor=ffffff]]
-[[https://gitlab.sintef.no/co-simulation/dds-fmu/-/packages][https://img.shields.io/badge/Artifacts-FMU-red.svg?style=flat-square&color=c8102e&labelColor=ffffff&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAgCAYAAABgrToAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAA6klEQVRYw2NkIACM7T3+w9hnD+5gZKAzYCLWcQMFmAaz4xgYGBhYcDhuAxLX8OzBHRcGWwj6I6W7C4MyigcLIORAx8HuwAEHjKTmVuSyEJde9PKSWHXY1DNR23HocsSqw1fMNGIRr4fSCxkYGB4QaXAjkj6i1MDU4auhCAWx49mDOw6QWv2hO46QGnxJgoWSBIzH5xMZGBjyCeklJm2SnIuJSTdnD+4oIKWBgc9MlsFYtJCdi0cL6lEHjjpw1IHDsblFTl08GoKjDhx14FAAg2Xog/GEgB6GQyw+XGJkYGBgwCY3KBw4iIAAAEeRaCNcUO12AAAAAElFTkSuQmCC]]
-[[https://gitlab.sintef.no/co-simulation/dds-fmu][https://img.shields.io/badge/Gitlab-Code-gray.svg?style=flat-square&color=e24329&logo=gitlab]]
+[[https://www.dnv.com/research/][https://img.shields.io/badge/DNV-GRD-99D9F0.svg?style=flat-square&labelColor=white&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA2MTIuMjcgMjYxLjQ5Ij48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6Izk4ZDlmMDt9LmNscy0ye2ZpbGw6IzNmOWMzNTt9LmNscy0ze2ZpbGw6IzAwMzU5MTt9LmNscy00e2ZpbGw6IzBmMjA0Yjt9PC9zdHlsZT48L2RlZnM+PGcgaWQ9IkxheWVyXzIiIGRhdGEtbmFtZT0iTGF5ZXIgMiI+PGcgaWQ9IkxheWVyXzEtMiIgZGF0YS1uYW1lPSJMYXllciAxIj48cmVjdCBjbGFzcz0iY2xzLTEiIHdpZHRoPSI2MTIuMjciIGhlaWdodD0iNzMuMSIvPjxyZWN0IGNsYXNzPSJjbHMtMiIgeT0iOTcuNDUiIHdpZHRoPSI2MTIuMjciIGhlaWdodD0iMTIuMTkiLz48cmVjdCBjbGFzcz0iY2xzLTMiIHk9IjEyMS43OSIgd2lkdGg9IjYxMi4yNyIgaGVpZ2h0PSIyNC4zNSIvPjxwYXRoIGNsYXNzPSJjbHMtNCIgZD0iTTM3MC4yOCwxODYuOTFxLTktNC0yMS40OS00SDMwNi4yM3Y3OC42Mmg0Mi41NnExMi40OCwwLDIxLjQ5LTRhMjkuNzcsMjkuNzcsMCwwLDAsMTMuODQtMTIuMTVxNC44MS04LjEzLDQuODItMjAuMzl2LTUuNDZxMC0xMi4yNS00LjgyLTIwLjM4QTI5Ljc5LDI5Ljc5LDAsMCwwLDM3MC4yOCwxODYuOTFabTUuNzcsMzcuNThxMCwxMi43OC02LjgyLDE5dC0yMC4zMyw2LjE5SDMxOS4zNFYxOTQuNzJIMzQ4LjlxMTMuNTIsMCwyMC4zMyw2dDYuODIsMTkuMTNaIi8+PHBvbHlnb24gY2xhc3M9ImNscy00IiBwb2ludHM9IjQ4Ny4zNyAyNDQuMzEgNDI2LjU3IDE4Mi44NyA0MTkuMzQgMTgyLjg3IDQxMy43OSAxODIuODcgNDEzLjc5IDI2MS40OSA0MjYuNTcgMjYxLjQ5IDQyNi41NyAyMDAuMTMgNDg3LjM3IDI2MS40OSA1MDAuMjcgMjYxLjQ5IDUwMC4yNyAxODIuODcgNDg3LjM3IDE4Mi44NyA0ODcuMzcgMjQ0LjMxIi8+PHBvbHlnb24gY2xhc3M9ImNscy00IiBwb2ludHM9IjU5OC4yOCAxODIuODcgNTY4LjIgMjQ0LjMxIDUzOC4xMSAxODIuODcgNTIzLjMzIDE4Mi44NyA1NjIuNzUgMjYxLjQ5IDU3Mi45MSAyNjEuNDkgNjEyLjIyIDE4Mi44NyA1OTguMjggMTgyLjg3Ii8+PC9nPjwvZz48L3N2Zz4=]]
 [[https://www.sintef.no/ocean][https://img.shields.io/badge/SINTEF-Ocean-white.svg?style=flat-square&labelColor=023366&color=023366&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAACc1BMVEUAAAAiIiJNTU1OTk5oaGh4eHiEhISGhoaHh4eIiIiJiYmLi4uTk5OdnZ2qqqqvr6+1tbW2tra3t7e4uLi5ubm6urr////6+vr7+/v+/v78/Pz9/f36+vr7+/v7+/v8/Pz7+/v8/Pz7+/v7+/v8/Pz8/Pz7+/v8/Pz7+/v8/Pz7+/v8/Pz7+/v8/Pz7+/v8/Pz8/Pz7+/v8/Pz9/f37+/v7+/v8/Pz8/Pz7+/v8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Pz8/Py89OkCAAAA0HRSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQICAwMEBAUFBgcHCAkJCgoLDA0NDw8QEREREhMUFRYWFxkdHyAiJCUnKissLS4vMDEyMzQ2Nzk6PD9CQ0RFRkpLTE5PUFFUVVdZWltdXl9gYmRlZ2prbG1ub3Fyc3R3eHx9foCBgoeIio+RkpOVmJ2en6ChoqOlpqeoq7GytLa4ubq7vL2+v8DBwsPExcbLzs/Q1NXW19jZ293e3+Hi4+Tl5ufo7O3v8PHy8/T19vf4+fr7/P3+kKTZQQAAAqJJREFUeNps02OjM1cUBeBVZpK6jV7btm3bNq5t27Zt2/bNzfpJPZOZus/nw73Xxt8Ylh06d/PWlaNr9Pgf2gtBZSMUevKb6qOfrMI//fKgkioPGPa9yep2X4u/2ZZMoTnG+/3zp7sh/Hi2oPGiBlAdrCNHQk4ZzAeu3n1w69gqCcAiv/EHEhQbqsm0A8b78T1WMiO2pDfXfiMgeU5egY0ugvTWn1UeMbsLWPmoaOCdDl+ntm6C7NICgwyPJsiF4oC3t3QQTHZz4WYcGAmUL/k+neVLrk3TGn9MgrTn8Gb9N4D02uqv0YWMbAVwaM56ZXkD59/Kq3dM09IedVoDTZzlMk7RDsBn5v38kXSUIHyibM5FwjFL5k+GhmwJSOT7X8tYYYagzaPizReaQssRRI+tgr6Bh7bP8xlkm2ep6F8LX36AG09j6VSH/g7HV0N2jCqx4RXD8ZKPsXshBx9ZYoBsZTdVwbjDTDzgZxxhHFwZA8X5MioScJtluEdnsSBSLAiDSnc8SV3wRCx4SmdxRZS4Ihx/MlUpV7iKK+z5WTwyWVyX/CX+FGZ7pDaF4QgVj9Q3lH21fb7W8Fe00m3f3DTCD9pSnhaFGjL+WmbZBxXWDMuF+s6DliM750Sh8JlnxCPcoMIzW6lPjTLzJweKUotm+WB5Q+9WKDTJolnfnmyj5fKKZtrZ2t2yGNemUxerC9brtZvcR0j/3zw4slUJzFvoHk2kbIHsxAv3lBGS4eYb0wyUlMj17YfmbGWX014J2mzKBt79cH2QInJqaIvWASK0nTWpEfPkmAjtcrdpKqFVYl8of1MnYn9Pjr1+h30jOfFA+tvgdL+yPVL/8Olr57DyOZJ/DY46evVepw04ZqWiV4zef4e3vbKawszvQ868BLM/AHN6VvaH1lCDAAAAAElFTkSuQmCC]]
+[[https://co-simulation.pages.sintef.no/dds-fmu][https://img.shields.io/badge/Docs-HTML-blue.svg?style=flat-square&logo=googledocs&logoColor=ffffff]]
+[[https://github.com/dnv-opensource/dds-fmu/releases][https://img.shields.io/badge/Artifacts-FMU-red.svg?style=flat-square&color=c8102e&labelColor=ffffff&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAgCAYAAABgrToAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAA6klEQVRYw2NkIACM7T3+w9hnD+5gZKAzYCLWcQMFmAaz4xgYGBhYcDhuAxLX8OzBHRcGWwj6I6W7C4MyigcLIORAx8HuwAEHjKTmVuSyEJde9PKSWHXY1DNR23HocsSqw1fMNGIRr4fSCxkYGB4QaXAjkj6i1MDU4auhCAWx49mDOw6QWv2hO46QGnxJgoWSBIzH5xMZGBjyCeklJm2SnIuJSTdnD+4oIKWBgc9MlsFYtJCdi0cL6lEHjjpw1IHDsblFTl08GoKjDhx14FAAg2Xog/GEgB6GQyw+XGJkYGBgwCY3KBw4iIAAAEeRaCNcUO12AAAAAElFTkSuQmCC]]
 [[https://prosjektbanken.forskningsradet.no/en][https://img.shields.io/badge/Research%20Council%20of%20Norway-Grant:%20309660-gray.svg?style=flat-square&labelColor=ffffff&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAAAAABXZoBIAAAAnElEQVR4AczJERDEMBSE4V8Ctc5Uz+XczjFerUNd4j5xPKpGQnWt2/nUYnuTCbV5c3wLb9/Oh37kXzET2zO7aRqHfEEHZ+1EywVH2GovzeIdfW0AvxXdkSLt+FR0hE+HWVrrfMOzQ68CRQF4dEg9OIBXhy0DwGxjUQQWE1dJBwQT9zrOJBPVYuJiomuYvsMeZZwCwsKskYM/geEBAKDGccZO9+2TAAAAAElFTkSuQmCC]]
 
-* Development
+* dds-fmu
 
   You will need [[https://conan.io/][conan 2]] and a compiler with =C++17= support. =gcc 12= and =msvc 19.2= are
   known to work. The conan compiler profile should specify at least
   =compiler.cppstd=17=. This project uses conan packages that are not available in
-  =conancenter=. You can add a remote with the missing packages with: =conan remote add
-  https://artifactory.smd.sintef.no/artifactory/api/conan/conan-local=.
+  =conancenter=. You can add a remote with the missing packages with: =conan remote add https://artifactory.smd.sintef.no/artifactory/api/conan/conan-local=.
   #+begin_src bash
     cd dds-fmu
     conan build . -o dds-fmu/*:with_doc=True -c tools.build:skip_test=False