Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crykn authored Jan 22, 2021
1 parent 2f366d1 commit 0282e8b
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This GitHub Action copies a folder from the current repository to a location in
uses: actions/checkout@v2

- name: Pushes test folder
uses: crykn/copy_folder_to_another_repo_action@v1.0.5
uses: crykn/copy_folder_to_another_repo_action@v1.0.6
env:
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
with:
Expand All @@ -26,14 +26,14 @@ This GitHub Action copies a folder from the current repository to a location in
commit_msg: '[GHA] Update the test files.'

# Variables
* source_folder: The folder to be moved.
* destination_repo: The repository to place the folder in.
* destination_folder: [optional] The folder in the destination repository to place the file in, if not the root directory.
* user_email: The GitHub user email associated with the API token secret.
* user_name: The GitHub username associated with the API token secret.
* destination_branch: [optional] The branch of the source repo to update, if not master.
* destination_branch_create: [optional] A branch to be created with this commit, defaults to commiting in `destination_branch`
* commit_msg: [optional] The commit message to use.
* **source_folder:** The folder to be moved.
* **destination_repo:** The repository to place the folder in.
* **destination_folder:** [optional] The folder in the destination repository to place the file in, if not the root directory.
* **user_email:** The GitHub user email associated with the API token secret.
* **user_name:** The GitHub username associated with the API token secret.
* **destination_branch:** [optional] The branch of the destination repo to base the changes on and push to (defaults to master).
* **destination_branch_create:** [optional] The branch the changes should be pushed to; defaults to commiting to `destination_branch`; is useful for creating PRs
* **commit_msg:** [optional] The commit message to use.

# Behavior Notes
The action will remove the destionation folder before recreating it to place any copied files in it.

0 comments on commit 0282e8b

Please sign in to comment.