📝 update readme

Author: jeoy

.github/actions/deploy/entrypoint.sh

@@ -31,20 +31,17 @@ then
   COMMIT_NAME="${GITHUB_ACTOR}"
 fi
 
-# Directs the action to the the Github workspace.
 cd $GITHUB_WORKSPACE && \
 
-# Configures Git.
 git init && \
 git config --global user.email "${COMMIT_EMAIL}" && \
 git config --global user.name "${COMMIT_NAME}" && \
 
 
-## Initializes the repository path using the access token.
 REPOSITORY_PATH="https://${ACCESS_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" && \
 
+git checkout "${BASE_BRANCH:-master}"
 
-# Builds the project if a build script is provided.
 echo "-----------------------Running build scripts... ---------------" 
 
 eval "$BUILD_SCRIPT" && \

.github/workflows/deploy.yml

@@ -18,7 +18,8 @@ jobs:
                   COMMIT_EMAIL: jeoy_z@126.com
                   COMMIT_NAME: jeoy
                   ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-                  BASE_BRANCH: master # The branch the action should deploy from.
-                  #   DEPLOY_BRANCH: gh-pages # The branch the action should deploy to.
-                  FOLDER: build # The folder the action should deploy.
-                  BUILD_SCRIPT: yarn && yarn build # The build script the action should run prior to deploying.
+                  BASE_BRANCH: master # The branch you want to build
+                  DEPLOY_BRANCH: gh-pages # The branch you want to deploy
+                  BUILD_SCRIPT: yarn && yarn build # The build script
+                  FOLDER: build # The folder generated by build script
+

README.md

@@ -1,4 +1,8 @@
-### This action will auto deploy to target branch when it get triggered
+# Github-deploy-actions
+
+This action will auto deploy to target branch when it get triggered
+
+# How It Works
 
 When push to `master` branch
 
@@ -8,4 +12,11 @@ Then push `build` folder as a new commit on `gh-pages` branch
 
 > note: mark sure `build` folder is on your gitignore list
 
-deploy page: [demo](https://jeoy.github.io/github-deploy-actions/)
+# deploy page:
+
+[demo](https://jeoy.github.io/github-deploy-actions/)
+
+## what exactly is done during the action
+
+checkout this
+[shell](https://github.com/jeoy/github-deploy-actions/blob/develop/.github/actions/deploy/entrypoint.sh)