ci: generate a static site with Hugo

Signed-off-by: knqyf263 <[email protected]>
aquasecurity · May 6, 2024 · c2c494c · c2c494c
1 parent a1c7fa3
commit c2c494c
Show file tree

Hide file tree

Showing 10 changed files with 242 additions and 7 deletions.
diff --git a/.github/workflows/deploy-index.yaml b/.github/workflows/deploy-index.yaml
@@ -5,19 +5,46 @@ on:
     branches: [ "main" ]
   workflow_dispatch:
 
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
 jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.125.6
     steps:
       - uses: actions/checkout@v4
-      - run: |
-          mkdir -p data/v1
-          cat plugins/*.yaml > data/v1/index.yaml
-      - uses: actions/upload-pages-artifact@v1
+      - name: Generate a list of plugins
+        run: |
+          mkdir -p site/data/v1
+          cat plugins/*.yaml > site/data/v1/plugins.yaml
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb     
+      - name: Install Dart Sass
+        run: sudo snap install dart-sass          
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Build with Hugo
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+        run: |
+          hugo \
+            -s site \
+            --gc \
+            --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"          
+      - uses: actions/upload-pages-artifact@v3
         with:
-          path: data
-
+          path: site/public
   deploy:
     needs: build
     name: Deploy
@@ -29,5 +56,6 @@ jobs:
       pages: write
       id-token: write
     steps:
-      - uses: actions/deploy-pages@v1
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4
         id: deployment
diff --git a/site/.hugo_build.lock b/site/.hugo_build.lock
diff --git a/site/archetypes/default.md b/site/archetypes/default.md
@@ -0,0 +1,5 @@
++++
+title = '{{ replace .File.ContentBaseName "-" " " | title }}'
+date = {{ .Date }}
+draft = true
++++
diff --git a/site/hugo.yaml b/site/hugo.yaml
@@ -0,0 +1,10 @@
+baseURL: "/"
+languageCode: en-us
+title: Trivy Plugins
+enableGitInfo: true
+enableRobotsTXT: true
+canonifyURLs: true
+
+disableKinds:
+- taxonomy
+
diff --git a/site/layouts/404.html b/site/layouts/404.html
@@ -0,0 +1,11 @@
+{{ define "main" }}
+
+<h1 class="display-3 text-danger">Not found</h1>
+
+<p class="lead">
+    Sorry, this URL cannot be found. Maybe it’s moved.
+</p>
+
+<a href=" {{ "/" }}  " class="btn btn-lg btn-primary">&larr; Home</a>
+
+{{ end }}
diff --git a/site/layouts/_default/baseof.html b/site/layouts/_default/baseof.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>{{ .Site.Title }}</title>
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css">
+  <link rel="stylesheet" href="/css/style.css">
+  <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/umd/popper.min.js"></script>
+  <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js"></script>
+  <style>
+    .stars {
+      display: inline-block;
+      vertical-align: middle;
+      margin-left: 10px;
+    }
+  </style>
+</head>
+
+{{ partial "header.html" . }}
+
+<body>
+  <main>
+    {{ block "main" . }}{{ end }}
+  </main>
+</body>
+</html>
+
diff --git a/site/layouts/index.html b/site/layouts/index.html
@@ -0,0 +1,41 @@
+{{ define "main" }}
+<body>
+  <div class="container">
+    <div class="row">
+      <div class="col-md-8 offset-md-2">
+        <h1>{{ .Site.Title }}</h1>
+        <p>Below you will find the list of Trivy plugins distributed on the centralized
+        <a href="https://github.com/aquasecurity/trivy-plugin-index">trivy-plugin-index</a>. To install these plugins on your machine:</p>
+        <ol>
+          <li><a href="https://aquasecurity.github.io/trivy/v0.51/getting-started/installation/">Install the latest version of Trivy</a></li>
+          <li>Run <code>trivy plugin install &lt;PLUGIN_NAME&gt;</code> to install a plugin.</li>
+        </ol>
+        <table class="table table-striped">
+          <thead>
+            <tr>
+              <th>Name</th>
+              <th>Type</th>
+              <th>Description</th>
+              <th>Repository</th>
+            </tr>
+          </thead>
+          <tbody>
+            {{ range .Site.Data.v1.plugins }}
+            <tr>
+              <td><a href="{{ .repo }}" target="_blank">{{ .name }}</a></td>
+              <td>{{ if .type }}{{ .type }}{{ else }}generic{{ end }}</td>
+              <td>{{ .summary }}</td>
+              <td>
+                <a href="{{ .repo }}" target="_blank">
+                  <img src="https://img.shields.io/github/stars/{{ replace .repo "https://github.com/" "" }}?style=social" alt="GitHub stars">
+                </a>
+              </td>
+            </tr>
+            {{ end }}
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+</body>
+{{ end }}
diff --git a/site/layouts/partials/header.html b/site/layouts/partials/header.html
@@ -0,0 +1,10 @@
+<header class="header">
+  <div class="container container-header">
+    <div class="logo">
+      <a href="/" class="header-logo">
+        <img src="/img/trivy-logo.svg" alt="Trivy Logo" style="height: 70px;">
+      </a>
+    </div>
+  </div>
+</header>
+
diff --git a/site/static/css/style.css b/site/static/css/style.css
@@ -0,0 +1,17 @@
+.header {
+  background-color: #f8f9fa;
+  padding: 10px 0;
+  margin: 0;
+  margin-bottom: 30px;
+}
+
+.logo {
+  display: flex;
+  align-items: center;
+  justify-content: flex-start;
+}
+
+.header-logo {
+  margin-top: -10px;
+  margin-left: 120px;
+}
diff --git a/site/static/img/trivy-logo.svg b/site/static/img/trivy-logo.svg