Skip to content

Commit

Permalink
Adding GitHub Pages support
Browse files Browse the repository at this point in the history
  • Loading branch information
nitya committed Jul 31, 2023
1 parent 1f252a3 commit 10df66b
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 3 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/docs-website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Deploy to GitHub Pages

on:
push:
branches: [main]
paths: [packages/docs/website/**]
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
cache-dependency-path: packages/docs/website/package-lock.json
- name: Build website
working-directory: packages/docs/website
run: |
npm ci
npm run build
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
10 changes: 10 additions & 0 deletions README.DEMO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contoso Real Estate Application - Demo Use Only!

This fork of the [Azure-Samples/contoso-real-estate](https://github.com/Azure-Samples/contoso-real-estate) application is intended **only for local exploration and demo use** and not for contributions back to source.

## Experiment 1: Deploy to GitHub Pages

This version is configured to automatically deploy the website package to the associated GitHub Pages endpoint using [Docusuarus Deployment](https://docusaurus.io/docs/deployment#deploying-to-github-pages) guidance.
- Added .github/workflows/docs-website.yml
- Updated Settings to deploy from GitHub Actions
- Modified docusarus settings to reflect github pages configuration
6 changes: 3 additions & 3 deletions packages/docs/website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ const config = {

// ------- Required Fields -------
title: 'Contoso Real Estate: Developer Guide',
url: 'https://azure-samples.github.io',
baseUrl: '/', // set this to '/contoso-real-estate/' for GitHub pages deployment
url: 'https://30daysof.github.io',
baseUrl: '/contoso-real-estate/', // set this to '/contoso-real-estate/' for GitHub pages deployment

// ------- Optional: deploy related -------
organizationName: 'Azure-Samples', // needed only for GitHub Pages deployment
organizationName: '30daysof', // needed only for GitHub Pages deployment
projectName: 'contoso-real-estate', // -- ditto --
deploymentBranch: "gh-pages",

Expand Down

0 comments on commit 10df66b

Please sign in to comment.