GitHub Action for GitHub Commit & Push

The GitHub Actions for commiting & 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@master
      with:
        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
        fetch-depth: 0             # otherwise, you will fail to push refs to dest repo
    - name: Create local changes
      run: |
        ...
    - name: Commit & Push changes
      uses: actions-js/push@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}

Inputs

name	value	default	description
github_token	string		Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}`.
author_email	string	'github-actions[bot]@users.noreply.github.com'	Email used to configure user.email in `git config`.
author_name	string	'github-actions[bot]'	Name used to configure user.name in `git config`.
coauthor_email	string		Email used to make a co-authored commit.
coauthor_name	string		Name used to make a co-authored commit.
message	string	'chore: autopublish ${date}'	Commit message.
branch	string	'main'	Destination branch to push changes.
empty	boolean	false	Allow empty commit.
amend	boolean	false	Determines if the commit should be amended. Needs to be used with `force` input to force push the amended commit.
force	boolean	false	Determines if force push is used.
tags	boolean	false	Determines if `--tags` is used.
rebase	boolean	false	Determines if `git pull --rebase` is used before the push. This is useful if multiple actions try to push at the same time.
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.

License

The Dockerfile and associated scripts and documentation in this project are released under the MIT License.

Credits

This is a slight modification of the ad-m/github-push-action action.

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.

actions-js / push

readme