From b8a55ec66f33ae6f7be10da199d7cd055e70a6bc Mon Sep 17 00:00:00 2001 From: Greg Brimble Date: Sat, 25 Apr 2020 13:59:18 +0100 Subject: [PATCH] Finish v1 --- .github/workflows/default.yml | 4 ++-- README.md | 20 ++++++++++++++------ entrypoint.sh | 2 +- 3 files changed, 17 insertions(+), 9 deletions(-) diff --git a/.github/workflows/default.yml b/.github/workflows/default.yml index c169147..4b77413 100644 --- a/.github/workflows/default.yml +++ b/.github/workflows/default.yml @@ -19,5 +19,5 @@ jobs: # The following are optional (see the README.md for more info) token: ${{ secrets.TOKEN }} - output: gregbrimble/tailwindui - repository: gregbrimble/tailwindui + output: GregBrimble/tailwindui + repository: GregBrimble/tailwindui diff --git a/README.md b/README.md index 1bda84d..6afb1e6 100644 --- a/README.md +++ b/README.md @@ -38,14 +38,22 @@ A full example can be found in [`.github/workflows/default.yml`](https://github. The following input options are available: -| Name | Value | -| ---------- | ----------------------------------------- | -| `email` | Your tailwindui.com account email address | -| `password` | Your tailwindui.com account password | +| Name | Value | Required? | Notes | +| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `email` | Your tailwindui.com account email address | Yes | | +| `password` | Your tailwindui.com account password | Yes | | +| `token` | [A GitHub Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) with the `repo` scope | No | Defaults to the automatically provided [`{{ github.token }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) | +| `output` | The repository to output to
e.g. `gregbrimble/tailwindui` | No | Defaults to the current repository (`{{ github.repository }}`) | +| `commitmessage` | The message to commit with in the output repository | No | Defaults to `Update tailwindui.com` | +| `branch` | The branch to commit changes to | No | Defaults to `master` | +| `force` | `true` \| `false` | No | Defaults to `false` | +| `actor` | The GitHub user to commit changes with
e.g. `gregbrimble` | No | Defaults to the current user (`{{ github.actor }}`) | +| `repository` | The workspace repository
e.g. `gregbrimble/tailwindui` | No | Defaults to the current repository (`{{ github.repository }}`). Should contain a `.env` file in the root. | +| `crawler` | The repository of the crawler to use | No | Defaults to `kiliman/tailwindui-crawler` | Note: If using a separate private repository for the output, you must include a Personal Access Token in the `token` input, as the `{{ github.token }}` tokens are scoped to only the current repository. ## Roadmap -[] Specify crawler version -[] Create a PR against the output repository +- [] Specify crawler version +- [] Create a PR against the output repository diff --git a/entrypoint.sh b/entrypoint.sh index d4396d5..404ca6b 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -69,4 +69,4 @@ fi remote="https://$INPUT_ACTOR:$INPUT_TOKEN@github.com/$OUTPUT_REPOSITORY.git" -git push $remote "HEAD:$INPUT_BRANCH" $force_option \ No newline at end of file +git push $remote "HEAD:$INPUT_BRANCH" $force_option && exit 0 \ No newline at end of file