Skip to content

Commit

Permalink
Merge pull request #2 from erikshafer/github-workflows-deploy-to-gith…
Browse files Browse the repository at this point in the history
…ub-pages

Deploying Docs to GitHub Pages
  • Loading branch information
erikshafer authored May 23, 2024
2 parents 3e36398 + d77188a commit 0bd21a2
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
39 changes: 39 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Deploy to GitHub Pages

on:
# Trigger the workflow every time you push to the `main` branch
# Using a different branch name? Replace `main` with your branch’s name
push:
branches: [main]
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

# Allow this job to clone the repo and create a page deployment
permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository using git
uses: actions/checkout@v3
- name: Install, build, and upload your site
uses: withastro/action@v1
with:
path: docs
# node-version: 18 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
# package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
5 changes: 4 additions & 1 deletion astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@ import starlight from '@astrojs/starlight';

// https://astro.build/config
export default defineConfig({
site: 'https://event-sourcing-ecommerce.github.io',
base: '/docs',
trailingSlash: 'never',
integrations: [
starlight({
title: 'Event Sourcery',
social: {
github: 'https://github.com/withastro/starlight',
github: 'https://github.com/erikshafer/event-sourcing-ecommerce',
},
sidebar: [
{
Expand Down

0 comments on commit 0bd21a2

Please sign in to comment.