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:
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 -m "Add changes" -a
- 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 force-with-lease parameter to force push to a repository:
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 -m "Add changes" -a
- name: Push changes
uses: ad-m/github-push-action@master
with:
force_with_lease: true
An example workflow to authenticate with GitHub Platform via Deploy Keys or in general SSH:
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 -m "Add changes" -a
- 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 or a repo scoped Personal Access Token. |
ssh | boolean | false | Determines if ssh/ Deploy Keys is used. |
branch | string | (default) | Destination branch to push changes. 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 }} . |
tags | boolean | false | Determines if --tags is used. |
directory | string | '.' | Directory to change to before pushing. |
repository | string | '' | Repository name. Default or empty repository name represents current github repository. If you want to push to other repository, you should make a personal access token and use it as the github_token input. |
Troubeshooting
Please be aware, if your job fails and the corresponding output log looks like the following error, update your used verson of the action to ad-m/github-push-action@master
:
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
License
The Dockerfile and associated scripts and documentation in this project are released under the MIT 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.