Skip to content

Commit

Permalink
docs: Add protected branch support to the documentation (#171)
Browse files Browse the repository at this point in the history
  • Loading branch information
ZPascal authored Jun 6, 2023
1 parent df39337 commit d9117be
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ jobs:
token: ${{ secrets.PAT_TOKEN }}
- name: Commit files
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git config --local user.email "test@test.com"
git config --local user.name "Test"
git commit -a -m "Add changes"
- name: Push changes
uses: ad-m/github-push-action@master
Expand Down Expand Up @@ -162,6 +162,31 @@ jobs:
branch: ${{ github.ref }}
```
An example workflow to push to a protected branch inside your own repository. Be aware that it's necessary to use a personal access token, and maybe it is a good idea to specify the force-with-lease flag in case of sync and push errors:
```yaml
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
fetch-depth: 0
token: ${{ secrets.PAT_TOKEN }}
- name: Commit files
run: |
git config --local user.email "test@test.com"
git config --local user.name "Test"
git commit -a -m "Add changes"
- name: Push changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.PAT_TOKEN }}
repository: Test/test
force_with_lease: true
```
### Inputs
| name | value | default | description |
Expand Down

0 comments on commit d9117be

Please sign in to comment.