diff --git a/README.md b/README.md index e8ec64f..fa3634e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ # github-wiki-action -Updates your GitHub wiki by using diffs. +Updates your GitHub wiki by using rsync. -Repo is WIP! +This action updates your repository's wiki +based on a single directory that matches with +your Wiki's git. + +It is recommended that you still have a Home.md +or whatever extension you want instead of MD. Largely inspired by https://github.com/Decathlon/wiki-page-creator-action and the [issue that arose from it](https://github.com/Decathlon/wiki-page-creator-action/issues/11), @@ -35,7 +40,8 @@ jobs: - name: Push Wiki Changes uses: Andrew-Chen-Wang/github-wiki-action@v1 env: - WIKI_DIR: wiki + # Make sure you have that / at the end. We use rsync + WIKI_DIR: wiki/ GH_PAT: ${{ secrets.GH_PAT }} GH_MAIL: ${{ secrets.YOUR_EMAIL }} GH_NAME: ${{ github.repository_owner }} diff --git a/action.yml b/action.yml index 9dfd087..d274654 100644 --- a/action.yml +++ b/action.yml @@ -1,6 +1,6 @@ name: GitHub Wiki Action author: Andrew Chen Wang -description: This Github action publishes Wiki pages with a provided markdown section into your GitHub repository's Wiki. +description: This action publishes Wiki pages with a provided directory into your GitHub repository's Wiki. runs: using: 'docker' image: 'Dockerfile' diff --git a/entrypoint.sh b/entrypoint.sh index 7a01220..071d97b 100644 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -13,13 +13,13 @@ if [ -z "$GH_NAME" ]; then fi if [ -z "$REPO" ]; then - echo "REPO ENV is missing. Use the one from the README" + echo "REPO ENV is missing. Using the one from the README" REPO=$GITHUB_REPOSITORY fi if [ -z "$WIKI_DIR" ]; then - echo "WIKI_FOLDER ENV is missing, using default wiki" - WIKI_DIR='wiki' + echo "WIKI_FOLDER ENV is missing, using default wiki/" + WIKI_DIR='wiki/' fi if [ -z "$WIKI_PUSH_MESSAGE" ]; then