Fork of ad-mgithub-push-action action

Clone this repo:

Branches

  1. b007e7b add cacompatibility for gh latest main branch (#66) by Yuxiaoy1 · 6 months ago master
  2. 40bf560 Use master checkout (#53) by Adam Dobrawy · 11 months ago
  3. a53759b Add checkout options to the example (#46) by DougCh · 11 months ago
  4. f18534c Fix undefined variable TAGS with INPUT_TAGS (#54) by Kevin Del Castillo · 12 months ago
  5. fe38f0a Update start.js for pass code from start.sh (#45) by Adam Dobrawy · 1 year, 2 months ago

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@master
      with:
        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
    - name: Create local changes
      run: |
        ...
    - name: Commit files
      run: |
        git config --local user.email "action@github.com"
        git config --local user.name "GitHub Action"
        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 }}

Inputs

namevaluedefaultdescription
github_tokenstringToken for the repo. Can be passed in using ${{ secrets.GITHUB_TOKEN }}.
branchstringDestination branch to push changes. Can be passed in using ${{ github.ref }}.
forcebooleanfalseDetermines if force push is used.
tagsbooleanfalseDetermines if --tags is used.
directorystring‘.’Directory to change to before pushing.
repositorystring''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.

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.