From 6867b4774e28a59635bacd1031753dd3d1fbf6ce Mon Sep 17 00:00:00 2001 From: Joshua Winkler Date: Thu, 15 Aug 2024 22:17:45 +0200 Subject: [PATCH] chore: add github actions --- .github/workflows/deploy.yml | 53 +++++++++++++++++++++++++++++++ .github/workflows/test-deploy.yml | 29 +++++++++++++++++ docusaurus.config.ts | 2 ++ 3 files changed, 84 insertions(+) create mode 100644 .github/workflows/deploy.yml create mode 100644 .github/workflows/test-deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..e90042a --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,53 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: + - main + # 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: + build: + name: Build Docusaurus + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Install pnpm + uses: pnpm/action-setup@v4 + with: + version: 9 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: pnpm + - name: Install dependencies + run: pnpm install --frozen-lockfile + - name: Build website + run: pnpm build + - name: Upload Build Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: build + + deploy: + name: Deploy to GitHub Pages + needs: build + + # 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 }} + + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml new file mode 100644 index 0000000..ff07eaa --- /dev/null +++ b/.github/workflows/test-deploy.yml @@ -0,0 +1,29 @@ +name: Test deployment + +on: + pull_request: + branches: + - main + # 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: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Install pnpm + uses: pnpm/action-setup@v4 + with: + version: 9 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: pnpm + - name: Install dependencies + run: pnpm install --frozen-lockfile + - name: Test build website + run: pnpm build \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ed85781..25798d4 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -17,6 +17,8 @@ const config: Config = { // If you aren't using GitHub pages, you don't need these. organizationName: "gommehdnet", // Usually your GitHub org/user name. projectName: "citybuild-wiki", // Usually your repo name. + deploymentBranch: "gh-pages", + trailingSlash: false, onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn",