Add input option for README.md creation

Author: seanzhengw

README.md

@@ -26,6 +26,7 @@ Setup workflow at branch `master` or `docs` may be a good idea.
       - uses: seanzhengw/sphinx-pages@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
+          create_readme: true
 
 ## Example Usage for standalone Sphinx documentation
 

action.yml

@@ -8,6 +8,9 @@ inputs:
   github_token:
     description: 'Token for the repo. Can be passed in using $\{{ secrets.GITHUB_TOKEN }}'
     required: true
+  create_readme:
+    description: 'Auto create a README.md file at branch gh-pages root with repo/branch/commit links'
+    default: false
 outputs:
   name:
     description: 'Author name'

entrypoint.sh

@@ -82,6 +82,14 @@ git config user.email $author_email
 echo "sphinx-build -b html $docs_src/source $docs_html -E -d $sphinx_doctree"
 sphinx-build -b html $docs_src/source $docs_html -E -d $sphinx_doctree
 
+# auto creation of README.md
+if [ "$INPUT_CREATE_README" = true ] ; then
+    echo "Create file README.md"
+    echo "GitHub Pages of [$GITHUB_REPOSITORY](https://github.com/$GITHUB_REPOSITORY.git)" > README.md
+    echo "===" >> README.md
+    echo "Sphinx html documentation of [$docs_sha8](https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA)" >> README.md
+fi
+
 # commit and push
 echo "git add ."
 git add .