75ba9fb1cf
* fix: Remove the user * doc: Adjust the documentation * fix: Add empty line at the end of the file
206 lines
9.7 KiB
Markdown
206 lines
9.7 KiB
Markdown
# GitHub Action for GitHub Push
|
|
|
|
The GitHub Actions for pushing to GitHub repository local changes authorizing using GitHub token.
|
|
|
|
With ease:
|
|
|
|
- update new code placed in the repository, e.g. by running a linter on it,
|
|
- track changes in script results using Git as archive,
|
|
- publish page using GitHub-Pages,
|
|
- mirror changes to a separate repository.
|
|
|
|
## Usage
|
|
|
|
### Example Workflow file
|
|
|
|
An example workflow to authenticate with GitHub Platform and to push the changes to a specified reference, e.g. an already available branch:
|
|
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
with:
|
|
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
|
|
fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
|
|
- name: Create local changes
|
|
run: |
|
|
...
|
|
- name: Commit files
|
|
run: |
|
|
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
git config --local user.name "github-actions[bot]"
|
|
git commit -a -m "Add changes"
|
|
- name: Push changes
|
|
uses: ad-m/github-push-action@master
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
branch: ${{ github.ref }}
|
|
```
|
|
|
|
An example workflow to use the branch parameter to push the changes to a specified branch e.g. a Pull Request branch:
|
|
|
|
```yaml
|
|
name: Example
|
|
on: [pull_request, pull_request_target]
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
ref: ${{ github.head_ref }}
|
|
fetch-depth: 0
|
|
- name: Commit files
|
|
run: |
|
|
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
|
git config --local user.name "github-actions[bot]"
|
|
git commit -a -m "Add changes"
|
|
- name: Push changes
|
|
uses: ad-m/github-push-action@master
|
|
with:
|
|
branch: ${{ github.head_ref }}
|
|
```
|
|
|
|
An example workflow to use the force-with-lease parameter to force push to a repository:
|
|
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
ref: ${{ github.head_ref }}
|
|
fetch-depth: 0
|
|
- name: Commit files
|
|
run: |
|
|
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
|
git config --local user.name "github-actions[bot]"
|
|
git commit -a -m "Add changes"
|
|
- name: Push changes
|
|
uses: ad-m/github-push-action@master
|
|
with:
|
|
force_with_lease: true
|
|
```
|
|
|
|
An example workflow to use the non default token push to another repository. Be aware that the force-with-lease flag is in such a case not possible:
|
|
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
ref: ${{ github.head_ref }}
|
|
fetch-depth: 0
|
|
token: ${{ secrets.PAT_TOKEN }}
|
|
- name: Commit files
|
|
run: |
|
|
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
|
git config --local user.name "github-actions[bot]"
|
|
git commit -a -m "Add changes"
|
|
- name: Push changes
|
|
uses: ad-m/github-push-action@master
|
|
with:
|
|
github_token: ${{ secrets.PAT_TOKEN }}
|
|
repository: Test/test
|
|
force: true
|
|
```
|
|
|
|
An example workflow to update/ overwrite an existing tag:
|
|
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
ref: ${{ github.head_ref }}
|
|
fetch-depth: 0
|
|
- name: Commit files
|
|
run: |
|
|
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
|
git config --local user.name "github-actions[bot]"
|
|
git tag -d $GITHUB_REF_NAME
|
|
git tag $GITHUB_REF_NAME
|
|
git commit -a -m "Add changes"
|
|
- name: Push changes
|
|
uses: ad-m/github-push-action@master
|
|
with:
|
|
force: true
|
|
tags: true
|
|
```
|
|
|
|
An example workflow to authenticate with GitHub Platform via Deploy Keys or in general SSH:
|
|
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
|
|
persist-credentials: true
|
|
- name: Create local changes
|
|
run: |
|
|
...
|
|
- name: Commit files
|
|
run: |
|
|
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
git config --local user.name "github-actions[bot]"
|
|
git commit -a -m "Add changes"
|
|
- name: Push changes
|
|
uses: ad-m/github-push-action@master
|
|
with:
|
|
ssh: true
|
|
branch: ${{ github.ref }}
|
|
```
|
|
|
|
### Inputs
|
|
|
|
| name | value | default | description |
|
|
|------------------| ----- | ------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| github_token | string | `${{ github.token }}` | [GITHUB_TOKEN](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow) <br /> or a repo scoped <br /> [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). |
|
|
| ssh | boolean | false | Determines if ssh/ Deploy Keys is used. |
|
|
| branch | string | (default) | Destination branch to push changes. <br /> Can be passed in using `${{ github.ref }}`. |
|
|
| force | boolean | false | Determines if force push is used. |
|
|
| force_with_lease | boolean | false | Determines if force-with-lease push is used. Please specify the corresponding branch inside `ref` section of the checkout action e.g. `ref: ${{ github.head_ref }}`. |
|
|
| atomic | boolean | true | Determines if [atomic](https://git-scm.com/docs/git-push#Documentation/git-push.txt---no-atomic) push is used. |
|
|
| tags | boolean | false | Determines if `--tags` is used. |
|
|
| directory | string | '.' | Directory to change to before pushing. |
|
|
| repository | string | '' | Repository name. <br /> Default or empty repository name represents <br /> current github repository. <br /> If you want to push to other repository, <br /> you should make a [personal access token](https://github.com/settings/tokens) <br /> and use it as the `github_token` input. |
|
|
|
|
## Troubleshooting
|
|
|
|
Please be aware, if your job fails and the corresponding output log looks like the following error, update your used version of the action to `ad-m/github-push-action@master` and check the used version of the `checkout` action (v2 is required):
|
|
```log
|
|
Push to branch ***************
|
|
fatal: unsafe repository ('/github/workspace' is owned by someone else)
|
|
To add an exception for this directory, call:
|
|
|
|
git config --global --add safe.directory /github/workspace
|
|
```
|
|
|
|
If you see the following error inside the output of the job, and you want to update an existing Tag:
|
|
```log
|
|
To https://github.com/Test/test_repository
|
|
! [rejected] 0.0.9 -> 0.0.9 (stale info)
|
|
error: failed to push some refs to 'https://github.com/Test/test_repository'
|
|
```
|
|
|
|
Please use the `force` instead the `force_with_lease` parameter. The update of the tag is with the `--force-with-lease` parameter not possible.
|
|
|
|
## License
|
|
|
|
The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).
|
|
|
|
## No affiliation with GitHub Inc.
|
|
|
|
GitHub are registered trademarks of GitHub, Inc. GitHub name used in this project are for identification purposes only. The project is not associated in any way with GitHub Inc. and is not an official solution of GitHub Inc. It was made available in order to facilitate the use of the site GitHub.
|