Skip to content

Commit

Permalink
chore: pmndrs/docs workflow (#290)
Browse files Browse the repository at this point in the history
* Create docs.yml

* home_redirect

* metadata image test

* Update docs.yml

* Add files via upload

* Update docs.yml

* Update docs.yml

* Update introduction.mdx

* Update docs.yml

* Update docs.yml

* disable sb deploy

* Update docs.yml
  • Loading branch information
abernier authored Aug 15, 2024
1 parent ba274f1 commit c55b7e0
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 13 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Build documentation and deploy to GitHub Pages
on:
push:
branches: ['master']
workflow_dispatch:

# Cancel previous run (see: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency)
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
uses: pmndrs/docs/.github/workflows/build.yml@main
with:
mdx: './docs'
libname: 'React Postprocessing'
home_redirect: '/introduction'
icon: '📬'
logo: '/logo.jpg'

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:
- id: deployment
uses: actions/deploy-pages@v4
26 changes: 13 additions & 13 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ jobs:
path: ./storybook-static

# See: https://github.com/actions/deploy-pages
deploy-job:
needs: release-job
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
# deploy-job:
# needs: release-job
# permissions:
# pages: write
# id-token: write
# environment:
# name: github-pages
# url: ${{ steps.deployment.outputs.page_url }}
# runs-on: ubuntu-latest
# steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v1
Binary file added docs/logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c55b7e0

Please sign in to comment.