You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,6 +87,7 @@ The following is an extended example with all possible options available for thi
87
87
disable_globbing: true
88
88
89
89
# Optional. Create given branch name in local and remote repository.
90
+
# (Not released yet, available when @master is used)
90
91
create_branch: true
91
92
```
92
93
@@ -106,7 +107,7 @@ on:
106
107
pull_request:
107
108
push:
108
109
branches:
109
-
- "main"
110
+
- main
110
111
111
112
jobs:
112
113
php-cs-fixer:
@@ -154,26 +155,26 @@ The goal of this Action is to be "the Action for committing files for the 80% us
154
155
155
156
The following is a list of edge cases the Action knowingly does not support:
156
157
157
-
**No `git pull` when the repository is out of the date with remote.** The will not do a `git pull` before doing the `git push`. **You** are responsible for keeping the repository up to date in your Workflow runs.
158
+
**No `git pull` when the repository is out of the date with remote.** The Action will not do a `git pull` before doing the `git push`. **You** are responsible for keeping the repository up to date in your Workflow runs.
158
159
159
-
**No support for running the Action in build matrices**. For example, if your Workflow is using build matrices, and you want that each job commits and pushes files to the remote, you will run into the issue, that the repository in the workflow will become out of date. As the Action will not do a `git pull` for you, you have to do that yourself.
160
+
**No support for running the Action in build matrices**. If your Workflow is using build matrices, and you want that each job commits and pushes files to the remote, you will run into the issue, that the repository in the workflow will become out of date. As the Action will not do a `git pull` for you, you have to do that yourself.
160
161
161
162
**No support for `git rebase` or `git merge`**. There are many strategies on how to integrate remote upstream changes to a local repository. `git-auto-commit` does not want to be responsible for doing that.
162
163
163
164
If this Action doesn't work for your workflow, check out [EndBug/add-and-commit](https://github.com/EndBug/add-and-commit).
164
165
165
166
### Checkout the correct branch
166
167
167
-
You must use `action/checkout@v2` or later versions to checkout the repository.
168
-
In non-`push` events, such as `pull_request`, make sure to specify the `ref` to checkout:
168
+
You must use `action/checkout@v2` or later versions to check out the repository.
169
+
In non-`push` events, such as `pull_request`, make sure to specify the `ref` to check out:
169
170
170
171
```yaml
171
172
- uses: actions/checkout@v2
172
173
with:
173
174
ref: ${{ github.head_ref }}
174
175
```
175
176
176
-
You have to do this to avoid that the `checkout`-Action clones your repository in a detached state.
177
+
Do this to avoid checking out the repository in a detached state.
177
178
178
179
### Commits made by this Action do not trigger new Workflow runs
179
180
@@ -362,7 +363,7 @@ This is due to limitations set up by GitHub, [commits of this Action do not trig
362
363
363
364
## Running the tests
364
365
365
-
The package has tests written in [bats](https://github.com/bats-core/bats-core). Before you can run the test suite locally, you have to install the dependencies with `npm` or `yarn`.
366
+
The Action has tests written in [bats](https://github.com/bats-core/bats-core). Before you can run the test suite locally, you have to install the dependencies with `npm` or `yarn`.
0 commit comments