Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optimize readme #27

Merged
merged 1 commit into from
Dec 27, 2020
Merged

optimize readme #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![Version](https://img.shields.io/github/v/release/tg908/fork-sync?style=flat-square)

Github action to sync your Forks.
This action uses octokit and the GitHub API to automatically create and merge a pull request with the head defined by `owner`:`head` into the base defined by `base`. If you create a PR in the same repository you can omit the `owner` parameter.
This action uses octokit and the GitHub API to automatically create and merge a pull request with the head defined by `head` into the base defined by `base`. The head branch owner is defined by `owner`. If you create a PR in the same repository you can omit the `owner` parameter.

# Example Workflow

Expand All @@ -21,7 +21,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: tgymnich/fork-sync@v1.2
- uses: tgymnich/fork-sync@v1.3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
owner: llvm
Expand Down Expand Up @@ -53,7 +53,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: tgymnich/fork-sync@v1.2
- uses: tgymnich/fork-sync@v1.3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
owner: llvm
Expand All @@ -80,4 +80,6 @@ jobs:

⚠️ $current_repo_owner is your own username!

⚠️ Only provide the branch name for `head` and `base`. `user:branch` will not work!

⚠️ * if `auto_approve` is set to `true` you must provide the `personal_token`!