docs: Improve custom branch clarity (#761)

peaceiris · Jun 14, 2022 · da72d05 · da72d05
1 parent ac45008
commit da72d05
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -163,6 +163,9 @@ jobs:
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
+        # If you're changing the branch from main, 
+        # also change the `main` in `refs/heads/main` 
+        # below accordingly.
         if: ${{ github.ref == 'refs/heads/main' }}
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}