Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
c-neto committed May 2, 2024
1 parent b483e91 commit 0521fb4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Replace all variables under `>>> REPLACE THE VALUE` in the [./mkdocs.yml](./mkdo

### 2. Configure the GitHub Action Permissions

The [.github/workflows/deploy-contents-to-github-pages.yml](.github/workflows/deploy-contents-to-github-pages.yml) pipeline need the `${{ secrets.GITHUB_TOKEN }}` variable to allow the static files push in `gh-pages` branch. For this, it is necessary to configure the _Read Write_ permission for GitHub action. Check the following image to configure it.
The [.github/workflows/deploy-contents-to-github-pages.yml](.github/workflows/deploy-contents-to-github-pages.yml) pipeline use the special variable `${{ secrets.GITHUB_TOKEN }}` to allow push action in the `gh-pages` branch. To achieve this, you need to configure the __Read Write__ permission for the GitHub action. This is necessary for the GitHub Action to create a branch and publish the built files. Check the following image for the configuration steps.

<table style="margin: 0 auto;"> <tr> <td style="text-align: center;">
<img src="./.img/how-to-configure-git-actions.png" alt="Image" />
Expand Down

0 comments on commit 0521fb4

Please sign in to comment.