diff --git a/README.md b/README.md index 165291794..06a6c3c93 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ The next example step will deploy `./public` directory to the remote `gh-pages` ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -171,7 +171,7 @@ jobs: run: hugo --minify - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 # If you're changing the branch from main, # also change the `main` in `refs/heads/main` # below accordingly. @@ -201,7 +201,7 @@ A GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -215,7 +215,7 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} publish_dir: ./public @@ -227,7 +227,7 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: personal_token: ${{ secrets.PERSONAL_TOKEN }} publish_dir: ./public @@ -240,7 +240,7 @@ The default is `gh-pages`. ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_branch: your-branch # default: gh-pages @@ -253,7 +253,7 @@ Only the contents of this dir are pushed to GitHub Pages branch, `gh-pages` by d ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./out # default: public @@ -268,7 +268,7 @@ A destination subdirectory on a publishing branch. The default is empty. ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} destination_dir: subdir @@ -285,7 +285,7 @@ Values should be split with a comma. ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} exclude_assets: '.github,exclude-file1,exclude-file2' @@ -295,7 +295,7 @@ Set `exclude_assets` to empty for including the `.github` directory to deploymen ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} # Recommended for this usage # personal_token: ${{ secrets.PERSONAL_TOKEN }} # An alternative @@ -307,7 +307,7 @@ The `exclude_assets` option supports glob patterns. ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} exclude_assets: '.github,exclude-file.txt,exclude-dir/**.txt' @@ -322,7 +322,7 @@ For more details about the `CNAME` file, read the official documentation: [Manag ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -340,7 +340,7 @@ Bypassing Jekyll makes the deployment faster and is necessary if you are deployi ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -357,7 +357,7 @@ For example: ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -377,7 +377,7 @@ For example: ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -396,7 +396,7 @@ For example: ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} external_repository: username/external-repository @@ -423,7 +423,7 @@ This allows you to make your publish branch with only the latest commit. ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -437,7 +437,7 @@ A commit is always created with the same user. ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -454,7 +454,7 @@ When we create a commit with a message `docs: Update some post`, a deployment co ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -468,7 +468,7 @@ use the `full_commit_message` option instead of the `commit_message` option. ```yaml - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -508,7 +508,7 @@ jobs: echo "DEPLOY_TAG_NAME=deploy-${TAG_NAME}" >> "${GITHUB_OUTPUT}" - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -666,7 +666,7 @@ Our project builds and provides build assets only when creating a release. This In this project, a major tag (e.g. v3) is guaranteed to contain no breaking changes. But, we recommend using a tag or a commit hash for the stability of your workflows. ```yaml -- uses: peaceiris/actions-gh-pages@v3.9.3 # tag: Better +- uses: peaceiris/actions-gh-pages@v4.0.0 # tag: Better with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public @@ -751,7 +751,7 @@ jobs: - run: npm run build - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -803,7 +803,7 @@ jobs: - run: npm run build - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -858,7 +858,7 @@ jobs: - run: yarn export - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -911,7 +911,7 @@ jobs: - run: npm run generate - name: deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -972,7 +972,7 @@ jobs: - run: yarn build - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -1036,7 +1036,7 @@ jobs: - run: mkdocs build - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -1079,7 +1079,7 @@ jobs: - run: mdbook build - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -1129,7 +1129,7 @@ jobs: run: flutter build web - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -1180,7 +1180,7 @@ jobs: # provide --output= option for `elm make` and remove this step - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} @@ -1233,7 +1233,7 @@ jobs: - run: publish-cli generate - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }}