Skip to content

chore: deploy tutorial to github pages #2226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
profanis wants to merge 3 commits into
base: master
Choose a base branch
from
+59 −1
Draft

chore: deploy tutorial to github pages #2226

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6efaef2
chore: deploy tutorial to github pages
profanis Oct 10, 2024
68e7dd9
chore: set the working dir in the gh action
profanis Nov 3, 2024
5e0d117
chore: update upload-pages-artifact action version
markwhitfeld Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
chore: deploy tutorial to github pages
  • Loading branch information
@profanis @markwhitfeld
profanis authored and markwhitfeld committed Oct 10, 2025
commit 6efaef26527635bec94ba7199ca0dd719fdc4f69
58 changes: 58 additions & 0 deletions .github/workflows/deploy-gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# This is a basic workflow to help you get started with Actions

name: Deploy tutorial to GitHub Pages

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "master" branch
push:
branches: [ "fp/tutorial-deploy" ]
pull_request:
branches: [ "fp/tutorial-deploy" ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4

- name: Install NGXS dependencies
run: yarn

- name: Install tutorial dependencies
run: yarn tutorials:install

- name: Build tutorial
env:
BASE_URL: store
run: npx nx run create-app:build --base /store --publicDir store --site https://ngxs.github.io/store --skip-nx-cache

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "@tutorials/create-app"

# Deployment job
deploy:
environment:
name: github-pages
url: ${{steps.deployment.outputs.page_url}}
runs-on: ubuntu-latest
needs: build

permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
3 changes: 2 additions & 1 deletion tutorials/create-app/astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ export default defineConfig({
devToolbar: {
enabled: false
},
integrations: [tutorialkit()]
integrations: [tutorialkit()],
site: 'https://ngxs.github.io/store'
});