# git-push

**Repository Path**: x-actions/git-push

## Basic Information

- **Project Name**: git-push
- **Description**: A Github Action to push code to git, like gitpage.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-25
- **Last Updated**: 2023-04-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Git Push Action

A Github Action to push code to git, like [`gitpage`](https://pages.github.com/).

## Environment Variables

- GITHUB_EMAIL: git user email
- GITHUB_USERNAME: git user username
- PUBLISH_REPO: repo url, `https://${{ secrets.GitHub_PAT }}@github.com/owner/repo.git`
- PUBLISH_BRANCH: git branch
- PUBLISH_DIR: dir to publish

## Secrets

- DEPLOY_PRIVATE_KEY: Required your deploy key which has Write access[not use]

## How to Use

```
    - name: Push to Github
      uses: x-actions/gh-pages@release/v1
      env:
        GITHUB_EMAIL: "me@xiexianbin.cn"
        GITHUB_USERNAME: "xiexianbin"
        PUBLISH_REPO: https://${{ secrets.GitHub_PAT }}@github.com/owner/repo.git
        PUBLISH_BRANCH: gh-pages
        PUBLISH_DIR: ./public
        # DEPLOY_PRIVATE_KEY: ${{ secrets.DEPLOY_PRIVATE_KEY }}
```