feat: export build info to global in example and deploy to github pages (#513)

Author: yjl9903

.github/workflows/ci.yml

@@ -11,8 +11,14 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        with:
+          fetch-depth: 0 # to fetch all history
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v2.4.0
@@ -34,3 +40,14 @@ jobs:
 
       - name: Test
         run: pnpm test
+
+      - name: Upload pages artifacts
+        # https://github.com/actions/upload-pages-artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'examples/vite/dist'
+
+      - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/main'
+        # https://github.com/actions/deploy-pages
+        uses: actions/deploy-pages@v4

examples/vite/index.html

@@ -18,6 +18,11 @@
         font-style: normal;
       }
 
+      a {
+        color: #0070f3;
+        text-decoration: none;
+      }
+
       #app {
         display: flex;
         flex-direction: column;

examples/vite/main.ts

@@ -19,9 +19,7 @@ import { name, version } from '~build/package';
 
 import { format } from 'date-fns';
 
-console.log('Build time:', now);
-
-const buildTime = document.querySelector('.container') as HTMLElement;
+const buildTime = document.querySelector<HTMLElement>('.container')!;
 
 function append(key: string, value: string | number | null) {
   const p = document.createElement('div');
@@ -35,6 +33,11 @@ function append(key: string, value: string | number | null) {
   buildTime.appendChild(p);
 }
 
+const h1 = document.createElement('h1');
+// use caution with `innerHTML`
+h1.innerHTML = `<a href="${github}" target="_blank">unplugin-info<a>`;
+buildTime.appendChild(h1);
+
 append('Build time: ', format(now, 'yyyy-MM-dd hh:mm'));
 append('CI: ', CI ? CI : 'Not a CI env');
 append('Github: ', github ? github : 'Not a github');
@@ -54,3 +57,6 @@ append('Message: ', message);
 
 append('Package name: ', name);
 append('Package version: ', version);
+append('', '');
+
+append('You can also open console and play around with it.', '');

examples/vite/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "playground",
+  "name": "unplugin-info-vite-demo",
   "version": "0.7.2",
   "private": "true",
   "type": "module",

examples/vite/vite.config.ts

@@ -2,5 +2,6 @@ import { defineConfig } from 'vite';
 import BuildInfo from 'unplugin-info/vite';
 
 export default defineConfig({
+  base: './',
   plugins: [BuildInfo({ meta: { message: 'This is set from vite.config.ts' } })]
 });