Clarify instructions on deployment on github pages #2988
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Agilulfo
commented
Sep 23, 2025
| env: | ||
| PAGES_BRANCH: master | ||
| BUILD_DIR: . | ||
| TOKEN: ${{ secrets.PUBLIC_TOKEN }} |
Author
There was a problem hiding this comment.
I'm not sure from where this is coming from but to be consistent with the description above this should be secrets.TOKEN
Agilulfo
commented
Sep 23, 2025
Comment on lines
-76
to
-88
| build: | ||
| runs-on: ubuntu-latest | ||
| if: github.ref != 'refs/heads/main' | ||
| steps: | ||
| - name: 'checkout' | ||
| uses: actions/checkout@v4 | ||
| - name: 'build' | ||
| uses: shalzz/zola-deploy-action@master | ||
| env: | ||
| PAGES_BRANCH: gh-pages | ||
| BUILD_DIR: . | ||
| TOKEN: ${{ secrets.TOKEN }} | ||
| # BUILD_ONLY: true |
Author
There was a problem hiding this comment.
I'm not sure why this job is in here.
To achieve what the instructions describe before this script the build_and_deploy job is sufficient
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation improvement
Some of the steps on how to deploy were not clear and could benefit from a little more clarity
If you agree I would actually split the github actions section in two clearly separated scenarios:
Sanity check: