-
Couldn't load subscription status.
- Fork 7
migration: Move from vanilla JS to Next.JS #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "extends": ["next/core-web-vitals", "next/typescript"] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| # Reference: https://github.com/actions/starter-workflows/blob/main/pages/nextjs.yml | ||
|
|
||
| # Sample workflow for building and deploying a Next.js site to GitHub Pages | ||
| # | ||
| # To get started with Next.js see: https://nextjs.org/docs/getting-started | ||
| # | ||
| name: Deploy Next.js site to Pages | ||
|
|
||
| on: | ||
| # When a commit is made to the main branch | ||
| 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 | ||
|
|
||
| # 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 | ||
|
|
||
| jobs: | ||
| # Build job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Detect package manager | ||
| id: detect-package-manager | ||
| run: | | ||
| if [ -f "${{ github.workspace }}/yarn.lock" ]; then | ||
| echo "manager=yarn" >> $GITHUB_OUTPUT | ||
| echo "command=install" >> $GITHUB_OUTPUT | ||
| echo "runner=yarn" >> $GITHUB_OUTPUT | ||
| exit 0 | ||
| elif [ -f "${{ github.workspace }}/package.json" ]; then | ||
| echo "manager=npm" >> $GITHUB_OUTPUT | ||
| echo "command=ci" >> $GITHUB_OUTPUT | ||
| echo "runner=npx --no-install" >> $GITHUB_OUTPUT | ||
| exit 0 | ||
| else | ||
| echo "Unable to determine package manager" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Setup Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "lts/*" | ||
| cache: ${{ steps.detect-package-manager.outputs.manager }} | ||
|
|
||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
|
|
||
| - name: Restore cache | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: | | ||
| .next/cache | ||
| # Generate a new cache whenever packages or source files change. | ||
| key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }} | ||
| # If source files changed but packages didn't, rebuild from a prior cache. | ||
| restore-keys: | | ||
| ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}- | ||
|
|
||
| - name: Install dependencies | ||
| run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }} | ||
|
|
||
| - name: Build with Next.js | ||
| run: ${{ steps.detect-package-manager.outputs.runner }} next build | ||
|
|
||
| - name: Add .nojekyll to out directory | ||
| run: touch out/.nojekyll | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: ./out | ||
|
|
||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,39 @@ | ||
| _site/ | ||
| *.swp | ||
| # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
| /.pnp | ||
| .pnp.js | ||
| .yarn/install-state.gz | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # next.js | ||
| /.next/ | ||
| /out/ | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| *.pem | ||
| .vscode/* | ||
|
|
||
| # debug | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| # local env files | ||
| .env*.local | ||
|
|
||
| # vercel | ||
| .vercel | ||
|
|
||
| # typescript | ||
| *.tsbuildinfo | ||
| next-env.d.ts | ||
|
|
||
| /job_stats.json |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| # Kata Containers Test Dashboard | ||
|
|
||
| This repository contains the **Kata Containers Test Dashboard**, a web application that visualizes data for the nightly tests run by the Kata Containers repository. Built using **Next.js** and styled with **TailwindCSS**, this dashboard provides a simple and efficient interface to monitor test results, leveraging modern frontend technologies to ensure responsive and scalable performance. | ||
|
|
||
| ## Features | ||
| - Fetches nightly CI test data using custom scripts. | ||
| - Displays weather-like icons to reflect test statuses (e.g., sunny for success, stormy for failures). | ||
| - Utilizes **Next.js** for server-side rendering and optimized builds. | ||
| - **TailwindCSS** for responsive, utility-first styling. | ||
| - Integration of **PrimeReact** components for UI elements. | ||
|
|
||
| --- | ||
|
|
||
| ## Project Structure | ||
|
|
||
| ```bash | ||
| . | ||
| ├── next.config.js # Next.js configuration | ||
| ├── package.json # Project dependencies and scripts | ||
| ├── package-lock.json # Dependency lock file | ||
| ├── pages | ||
| │ ├── _app.js # Application wrapper for global setup | ||
| │ └── index.js # Main dashboard page | ||
| ├── postcss.config.js # PostCSS configuration for TailwindCSS | ||
| ├── public | ||
| │ ├── cloudy.svg # Weather icons for test statuses | ||
| │ ├── favicon.ico | ||
| │ ├── partially-sunny.svg | ||
| │ ├── rainy.svg | ||
| │ ├── stormy.svg | ||
| │ └── sunny.svg | ||
| ├── README.md # Project documentation (this file) | ||
| ├── scripts | ||
| │ └── fetch-ci-nightly-data.js # Script to fetch nightly test data | ||
| ├── styles | ||
| │ └── globals.css # Global CSS imports | ||
| └── tailwind.config.js # TailwindCSS configuration | ||
| ``` | ||
|
|
||
| ### Key Files | ||
| - **`pages/index.js`**: The main entry point of the dashboard, displaying test results and their statuses. | ||
| - **`scripts/fetch-ci-nightly-data.js`**: Custom script to retrieve CI data for the dashboard. | ||
| - **`styles/globals.css`**: Custom global styles, mainly extending the TailwindCSS base. | ||
| - **`public/`**: Contains static assets like icons representing different test statuses. | ||
|
|
||
| --- | ||
|
|
||
| ## Setup Instructions | ||
|
|
||
| Follow these steps to set up the development environment for the Kata Containers Test Dashboard: | ||
|
|
||
| ### Prerequisites | ||
| - [**Node.js**](https://nodejs.org/en/download) (version 18.x or later recommended) | ||
| - **npm** (comes with Node.js) | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. **Clone the repository**: | ||
| ```bash | ||
| git clone https://github.com/kata-containers/kata-containers.github.io.git | ||
| cd kata-containers.github.io | ||
| ``` | ||
|
|
||
| 2. **Install dependencies**: | ||
| Run the following command to install both the project dependencies and development dependencies. | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ### Development | ||
|
|
||
| 3. **Run the development server**: | ||
| Start the Next.js development server with hot-reloading enabled. | ||
| ```bash | ||
| node scripts/fetch-ci-nightly-data.js > job_stats.json | ||
| npm run dev | ||
| ``` | ||
|
|
||
| The app will be available at [http://localhost:3000](http://localhost:3000). | ||
|
|
||
| ### Production | ||
|
|
||
| 4. **Build for production**: | ||
| To create an optimized production build, run: | ||
| ```bash | ||
| npm run build | ||
| ``` | ||
|
|
||
| 5. **Start the production server**: | ||
| After building, you can start the server: | ||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| ### Scripts | ||
|
|
||
| - **Fetch CI Nightly Data**: | ||
| The `fetch-ci-nightly-data.js` script can be executed manually to pull the latest CI test data from the Kata Containers repository: | ||
| ```bash | ||
| node scripts/fetch-ci-nightly-data.js > job_stats.json | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import Image from "next/image"; | ||
| import { basePath } from "../next.config.js"; | ||
|
|
||
| const icons = [ | ||
| "sunny.svg", | ||
| "partially-sunny.svg", | ||
| "cloudy.svg", | ||
| "rainy.svg", | ||
| "stormy.svg", | ||
| ]; | ||
|
|
||
| export const getWeatherIndex = (stat) => { | ||
| let fail_rate = 0; | ||
| fail_rate = (stat["fails"] + stat["skips"]) / stat["runs"]; | ||
| // e.g. failing 3/9 runs is .33, or idx=1 | ||
| var idx = Math.floor((fail_rate * 10) / 2); | ||
| if (idx == icons.length) { | ||
| // edge case: if 100% failures, then we go past the end of icons[] | ||
| // back the idx down by 1 | ||
| console.assert(fail_rate == 1.0); | ||
| idx -= 1; | ||
| } | ||
|
|
||
| // This error checks if there are zero runs. | ||
| // Currently, will display stormy weather. | ||
| if (isNaN(idx)) { | ||
| idx = 4; | ||
| } | ||
| return idx; | ||
| }; | ||
|
|
||
| const getWeatherIcon = (stat) => { | ||
| const idx = getWeatherIndex(stat); | ||
| return icons[idx]; | ||
| }; | ||
|
|
||
| export const weatherTemplate = (data) => { | ||
| const icon = getWeatherIcon(data); | ||
| return ( | ||
| <div> | ||
| <Image | ||
| src={`${basePath}/${icon}`} | ||
| alt="weather" | ||
| width={32} | ||
| height={32} | ||
| // priority | ||
| /> | ||
| </div> | ||
| ); | ||
| }; |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.