Skip to content

Commit 19c7b84

Browse files
committed
Update README
1 parent ebe7739 commit 19c7b84

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ The following is an extended example with all possible options available for thi
8787
disable_globbing: true
8888

8989
# Optional. Create given branch name in local and remote repository.
90+
# (Not released yet, available when @master is used)
9091
create_branch: true
9192
```
9293
@@ -106,7 +107,7 @@ on:
106107
pull_request:
107108
push:
108109
branches:
109-
- "main"
110+
- main
110111
111112
jobs:
112113
php-cs-fixer:
@@ -154,26 +155,26 @@ The goal of this Action is to be "the Action for committing files for the 80% us
154155

155156
The following is a list of edge cases the Action knowingly does not support:
156157

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.
158159

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.
160161

161162
**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.
162163

163164
If this Action doesn't work for your workflow, check out [EndBug/add-and-commit](https://github.com/EndBug/add-and-commit).
164165

165166
### Checkout the correct branch
166167

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:
169170

170171
```yaml
171172
- uses: actions/checkout@v2
172173
with:
173174
ref: ${{ github.head_ref }}
174175
```
175176

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.
177178

178179
### Commits made by this Action do not trigger new Workflow runs
179180

@@ -362,7 +363,7 @@ This is due to limitations set up by GitHub, [commits of this Action do not trig
362363

363364
## Running the tests
364365

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`.
366367

367368
```shell
368369
npm install

0 commit comments

Comments
 (0)