diff --git a/README.md b/README.md index 9973613..caba243 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,42 @@ # github-action-push-to-another-repository -Helps to push generated files to another directory +Used to push generated files from a directory from Git Action step into another repository on Github. + +E.g. +Repository pandoc-test contains Markdown and a Git Action to generate, using Pandoc, an output: HTML, PDF, odt, epub, etc. + +Repository pandoc-test-output: contains only the generated files from the first Git Action. Pushed here with github-action-push-to-another-repository + +And pandoc-test-output can have Git Pages to give access to the files (or just links to the raw version of the files) ## Inputs -### `source-folder` +### `source-directory` (argument) +From the repository that this Git Action is executed the directory that contains the files to be pushed into the repository. -### `destination-github-username` +### `destination-github-username` (argument) +For the repository `https://github.com/cpina/pandoc-test-output` is `cpina`. It's also used for the `Author:` in the generated git messages. -### `destination-repository-name` +### `destination-repository-name` (argument) +For the repository `https://github.com/cpina/pandoc-test-output` is `pandoc-test-output` + +### `user-email` (argument) +The email that will be used for the commit in the destination-repository-name. + +### `API_TOKEN_GITHUB` (environment) +E.g.: + `API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}` + +Generate it from the Settings of the account that needs access to push. ## Example usage -uses: actions/... TODO +` + - name: Pushes to another repository + uses: cpina/github-action-push-to-another-repository@master + env: + API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }} + with: + source-directory: 'output' + destination-github-username: 'cpina' + destination-repository-name: 'pandoc-test-output' + git-user-email: carles@pina.cat +` diff --git a/entrypoint.sh b/entrypoint.sh index a3523a2..56f1898 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -25,5 +25,5 @@ cp -r "$FOLDER"/* "$CLONE_DIR" cd "$CLONE_DIR" git add . -git commit --message "Update from $GITHUB_REPOSITORY" +git commit --message "Update from $GITHUB_REPOSITORY $GITHUB_REF ($GITHUB_SHA , https://github.com/$GITHUB_REPOSITORY/commit/$GITHUB_SHA)" git push origin master