From 6efaef26527635bec94ba7199ca0dd719fdc4f69 Mon Sep 17 00:00:00 2001 From: Fanis Prodromou Date: Thu, 10 Oct 2024 10:47:11 +0300 Subject: [PATCH 1/3] chore: deploy tutorial to github pages --- .github/workflows/deploy-gh-pages.yml | 58 +++++++++++++++++++++++++++ tutorials/create-app/astro.config.ts | 3 +- 2 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/deploy-gh-pages.yml diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml new file mode 100644 index 000000000..0681020a5 --- /dev/null +++ b/.github/workflows/deploy-gh-pages.yml @@ -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 diff --git a/tutorials/create-app/astro.config.ts b/tutorials/create-app/astro.config.ts index 429483aa1..4d0ae1540 100644 --- a/tutorials/create-app/astro.config.ts +++ b/tutorials/create-app/astro.config.ts @@ -6,5 +6,6 @@ export default defineConfig({ devToolbar: { enabled: false }, - integrations: [tutorialkit()] + integrations: [tutorialkit()], + site: 'https://ngxs.github.io/store' }); From 68e7dd9c44136a83332f077f39f3c05cb25941f3 Mon Sep 17 00:00:00 2001 From: Fanis Prodromou Date: Sun, 3 Nov 2024 19:49:14 +0100 Subject: [PATCH 2/3] chore: set the working dir in the gh action --- .github/workflows/deploy-gh-pages.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml index 0681020a5..705ff85fa 100644 --- a/.github/workflows/deploy-gh-pages.yml +++ b/.github/workflows/deploy-gh-pages.yml @@ -32,9 +32,8 @@ jobs: 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 + working-directory: tutorials/create-app + run: npx astro build --base /store --publicDir store --site https://ngxs.github.io/store - name: Upload artifact uses: actions/upload-pages-artifact@v2 From 5e0d11758592bac4f771dde05355fe254c749761 Mon Sep 17 00:00:00 2001 From: Mark Whitfeld Date: Fri, 10 Oct 2025 13:46:06 +0200 Subject: [PATCH 3/3] chore: update upload-pages-artifact action version --- .github/workflows/deploy-gh-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml index 705ff85fa..0add496cb 100644 --- a/.github/workflows/deploy-gh-pages.yml +++ b/.github/workflows/deploy-gh-pages.yml @@ -36,7 +36,7 @@ jobs: run: npx astro build --base /store --publicDir store --site https://ngxs.github.io/store - name: Upload artifact - uses: actions/upload-pages-artifact@v2 + uses: actions/upload-pages-artifact@v4 with: path: "@tutorials/create-app"