Skip to content

Commit

Permalink
feat: add website and github pages for docs (#5)
Browse files Browse the repository at this point in the history
* feat: add website and github pages for docs

* ci: fix eslint for ci
  • Loading branch information
joshblack authored Feb 13, 2024
1 parent b6d47ac commit 733ef0c
Show file tree
Hide file tree
Showing 27 changed files with 849 additions and 73 deletions.
7 changes: 7 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
# npm package output
dist

# GitHub Pages
out

# Next.js
.next
14 changes: 14 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,27 @@ const config = {
'import/no-unresolved': 'off',
},
overrides: [
{
files: ['**/*.ts', '**/*.tsx'],
rules: {
'filenames/match-regex': 'off',
'import/no-namespace': 'off',
'@typescript-eslint/no-namespace': 'off',
},
},
{
files: ['*.test.ts'],
rules: {
'github/no-inner-html': 'off',
'i18n-text/no-en': 'off',
},
},
{
files: ['website/**/*.ts', 'website/**/*.tsx'],
rules: {
'i18n-text/no-en': 'off',
},
},
],
}

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
- name: Build package
run: npm run build
- name: Lint package using publint
run: npx publint --strict
run: npm run lint:npm -ws --if-present

test:
runs-on: ubuntu-latest
Expand All @@ -57,7 +57,7 @@ jobs:
- name: Install dependencies
run: npm ci
- name: Build project
run: npm run build
run: npm run build -w @primer/live-region-element
- name: Run tests
run: npm test

Expand Down
47 changes: 47 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: deploy
on:
push:
branches:
- main

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Build project
run: npm run build
- uses: actions/upload-pages-artifact@v3
with:
path: ./website/out

deploy:
needs: build
runs-on: ubuntu-latest

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ custome-elements.json

# TypeScript
*.tsbuildinfo

# Next.js
.next
Loading

0 comments on commit 733ef0c

Please sign in to comment.