a7824cd3a2
* Add GitHub url and GitHub Enterprise support * Add review improvements * Modify the default value to github.server_url
62 lines
2.9 KiB
Markdown
62 lines
2.9 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,
|
|
- push changes to a hosted GitHub Enterprise Server instance,
|
|
- mirror changes to a separate repository.
|
|
|
|
## Usage
|
|
|
|
### Example Workflow file
|
|
|
|
An example workflow to authenticate with GitHub Platform:
|
|
|
|
```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 -m "Add changes" -a
|
|
- name: Push changes
|
|
uses: ad-m/github-push-action@master
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
branch: ${{ github.ref }}
|
|
```
|
|
|
|
### Inputs
|
|
|
|
| name | value | default | description |
|
|
| ---- | ----- | ------- | ----------- |
|
|
| github_token | string | `${{ github.token }}` | [GITHUB_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) <br /> or a repo scoped <br /> [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token). |
|
|
| github_url | string | `${{ github.server_url }}` | Specify the GitHub Enterprise or GitHub url|
|
|
| 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. |
|
|
| 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. |
|
|
|
|
## 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.
|