Skip to content
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

feature: add support for github pages #50

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .github/workflows/static.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# 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:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Use Node.js 16
uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'

- id: env
run: echo "repo-name=${GITHUB_REPOSITORY#$GITHUB_REPOSITORY_OWNER/}" >> $GITHUB_OUTPUT

- run: yarn install --frozen-lockfile
- run: yarn lint
- run: yarn test
- run: yarn build-prod
env:
WEBPACK_PUBLIC_PATH: "/${{ steps.env.outputs.repo-name }}"

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'dist/'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 2 additions & 1 deletion src/BrowserApp.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import React from 'react';
import { BrowserRouter } from 'react-router-dom';
import { SchemaApp } from './SchemaApp'
import { getBasename } from './basename'

export const App: React.FC = () => (
<BrowserRouter>
<BrowserRouter basename={getBasename() !== "" ? getBasename() : undefined}>
<SchemaApp />
</BrowserRouter>
)
4 changes: 4 additions & 0 deletions src/basename.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export const getBasename = () => {
const pathname = new URL(document.baseURI).pathname;
return pathname.endsWith("/") ? pathname.slice(0, -1) : pathname;
}
4 changes: 2 additions & 2 deletions webpack.common.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module.exports = {
new HtmlWebpackPlugin({
title: 'JSON Schema Viewer',
template: 'index.html',
publicPath: '/',
publicPath: process.env.WEBPACK_PUBLIC_PATH ?? '/',
filename: 'index.html'
}),
new CspHtmlWebpackPlugin({
Expand All @@ -51,7 +51,7 @@ module.exports = {
}),
new FaviconsWebpackPlugin({
logo: './src/logo.svg',
publicPath: '/',
publicPath: process.env.WEBPACK_PUBLIC_PATH ?? '/',
prefix: 'auto/[contenthash]'
})
]
Expand Down