Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/nextgen' into nextgen
Browse files Browse the repository at this point in the history
  • Loading branch information
csavelief committed Sep 27, 2023
2 parents 96869fb + c48825f commit 1ea7613
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 2 deletions.
61 changes: 61 additions & 0 deletions .github/workflows/deploy-jsdoc-to-github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Deploy JSDoc to GitHub Pages

on:
push:
branches:
- 'nextgen'

# 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

# Default to bash
defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Install Node.js dependencies
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
- name: Build doc with JSDoc
run: npm run doc
- name: Add Components test page
run: "cp -r ./dist/ ./docs/dist/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./docs

# 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@v2
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
node_modules
dist
docs
docs
.nyc_output
coverage
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
TODO
TODO

Link to [Components test page](dist/index.html)
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"scripts": {
"build": "rollup -c",
"dev": "rollup -c -w",
"doc": "jsdoc -c jsdoc.config.json",
"test": "jest"
},
"repository": {
Expand Down

0 comments on commit 1ea7613

Please sign in to comment.