actions/github-action-push-to-another-repository
1
0
Fork 0
mirror of https://github.com/cpina/github-action-push-to-another-repository.git synced 2025-09-05 08:05:47 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Emre Ercan 2021-02-12 15:26:04 +01:00 committed by GitHub
parent 8e2ab5ef1a
commit bb15c62cac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -5,33 +5,41 @@ Used to push generated files from a branch from Git Action step into a branch in
Basically, after running this action, the contents of the destination branch will be the same as the contents of the source branch. Basically, after running this action, the contents of the destination branch will be the same as the contents of the source branch.
**Note:** Both source and destination branch must exists. This action does not create the destination branch if it doesn't exists. **Note:** Both source and destination branch must exists. This action does not create the destination branch if it doesn't exists.
**Note:** The new commit will override the entire content of the destination branch with the source branch in a new commit. It does not override the history in destination branch. **Note:** The new commit will override the entire content of the destination branch with the source branch in a new commit. It does not override the history in destination branch.
## Inputs ## Inputs
### `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` (argument) ```yaml
For the repository `https://github.com/cpina/push-to-another-repository-output` is `cpina`. It's also used for the `Author:` in the generated git messages. source-repository-username:
description: 'Username/organization of the source repository'
### `destination-repository-name` (argument) required: true
For the repository `https://github.com/cpina/push-to-another-repository-output` is `push-to-another-repository-output` source-repository-name:
description: 'Name of the source repository'
*Warning:* this Github Action currently deletes all the files and directories in the destination repository. The idea is to copy from an `output` directory into the `destination-repository-name` having a copy without any previous files there. required: true
source-branch:
### `user-email` (argument) description: 'Name of the source branch'
The email that will be used for the commit in the destination-repository-name. required: true
destination-repository-username:
### `destination-repository-username` (argument) [optional] description: 'Username/organization of the destination repository'
The Username/Organization for the destination repository, if different from `destination-github-username`. For the repository `https://github.com/cpina/push-to-another-repository-output` is `cpina`. required: true
destination-repository-name:
### `target-branch` (argument) [optional] description: 'Name of the destination repository'
The branch name for the destination repository, if different from `master`. required: true
destination-branch:
### `commit-message` (argument) [optional] description: 'Name of the destination branch'
The commit message to be used in the output repository. Optional and defaults to "Update from $REPOSITORY_URL@commit". required: true
commit-user-email:
The string `ORIGIN_COMMIT` is replaced by `$REPOSITORY_URL@commit`. description: 'Email for the git commit'
required: true
commit-username:
description: 'User name for the git commit'
required: true
commit-message:
description: '[Optional] commit message for the output repository. ORIGIN_COMMIT is replaced by the URL@commit in the origin repo'
default: 'Update from ORIGIN_COMMIT'
required: false
```
### `API_TOKEN_GITHUB` (environment) ### `API_TOKEN_GITHUB` (environment)
E.g.: E.g.:
@ -50,23 +58,20 @@ Then make the token available to the Github Action following the steps:
## Example usage ## Example usage
```yaml ```yaml
- name: Pushes to another repository - name: Pushes to branch in another repository
uses: cpina/github-action-push-to-another-repository@master uses: emre-e/github-action-push-branch-to-another-repository-branch@master
env: env:
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }} API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
with: with:
source-directory: 'output' source-repository-username: 'example-username'
destination-github-username: 'cpina' source-repository-name: 'source-repo'
destination-repository-name: 'pandoc-test-output' source-branch: 'source-branch'
user-email: carles3@pina.cat destination-repository-username: 'emre-e'
destination-repository-name: 'dest-blog'
destination-branch: 'dest-branch'
commit-user-email: 'example.email@for.the.commit.com'
commit-username: 'example-username'
``` ```
Working example: ### Push directory into another repository instead
https://github.com/cpina/github-action-push-to-another-repository
https://github.com/cpina/push-to-another-repository-example/blob/master/.github/workflows/ci.yml
It generates files from:
https://github.com/cpina/push-to-another-repository-example
To:
https://github.com/cpina/push-to-another-repository-output