Skip to content

Commit

Permalink
docs: fix github workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
OzakIOne committed Mar 21, 2024
1 parent 5631528 commit 3aaaa6f
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions website/docs/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,6 @@ Here are two approaches to deploying your docs with GitHub Actions. Based on the

While you can have both jobs defined in the same workflow file, the original `deploy` workflow will always be listed as skipped in the PR check suite status, which is not indicative of the actual status and provides no value to the review process. We therefore propose to manage them as separate workflows instead.


<details>
<summary>GitHub action files</summary>

Expand All @@ -392,8 +391,8 @@ on:
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
deploy:
name: Deploy to GitHub Pages
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand All @@ -415,12 +414,13 @@ jobs:
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
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:
Expand All @@ -432,7 +432,6 @@ jobs:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

```

```yml title=".github/workflows/test-deploy.yml"
Expand Down

0 comments on commit 3aaaa6f

Please sign in to comment.