Skip to content

Commit c0e574b

Browse files
author
Ahmad Nassri
committed
docs(readme): update readme
1 parent d5ee5d3 commit c0e574b

File tree

1 file changed

+22
-24
lines changed

1 file changed

+22
-24
lines changed

Diff for: README.md

+22-24
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ steps:
8585
### Inputs
8686

8787
| input | required | default | description |
88-
| -------------- | -------- | ------------------------ | --------------------------------------------------- |
88+
|----------------|----------|--------------------------|-----------------------------------------------------|
8989
| `github-token` | ✔ | `github.token` | The GitHub token used to merge the pull-request |
9090
| `config` | ✔ | `.github/auto-merge.yml` | Path to configuration file *(relative to root)* |
9191
| `target` | ❌ | `patch` | The version comparison target (major, minor, patch) |
@@ -96,8 +96,8 @@ steps:
9696

9797
The GitHub token is a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with the following scopes:
9898

99-
- `repo` for private repositories
100-
- `public_repo` for public repositories
99+
- `repo` for private repositories
100+
- `public_repo` for public repositories
101101

102102
The token MUST be created from a user with **`push`** permission to the repository.
103103

@@ -107,12 +107,10 @@ The token MUST be created from a user with **`push`** permission to the reposito
107107

108108
Using the configuration file *(specified with `config` input)*, you have the option to provide a more fine-grained configuration. The following example configuration file merges
109109

110-
- minor updates for `aws-sdk`
111-
- minor development dependency updates
112-
- patch production dependency updates
113-
- minor security-critical production dependency updates
114-
115-
<!-- end list -->
110+
- minor updates for `aws-sdk`
111+
- minor development dependency updates
112+
- patch production dependency updates
113+
- minor security-critical production dependency updates
116114

117115
``` yaml
118116
- match:
@@ -135,22 +133,22 @@ Using the configuration file *(specified with `config` input)*, you have the opt
135133
#### Match Properties
136134

137135
| property | required | supported values |
138-
| ----------------- | -------- | ------------------------------------------ |
136+
|-------------------|----------|--------------------------------------------|
139137
| `dependency_name` | ❌ | full name of dependency, or a regex string |
140138
| `dependency_type` | ❌ | `all`, `production`, `development` |
141139
| `update_type` | ✔ | `all`, `security:*`, `semver:*` |
142140

143141
> **`update_type`** can specify security match or semver match with the syntax: `${type}:${match}`, e.g.
144-
>
145-
> - **security:patch**
142+
>
143+
> - **security:patch**
146144
> SemVer patch update that fixes a known security vulnerability
147-
>
148-
> - **semver:patch**
149-
> SemVer patch update, e.g. \> 1.x && 1.0.1 to 1.0.3
150-
>
151-
> - **semver:minor**
152-
> SemVer minor update, e.g. \> 1.x && 2.1.4 to 2.3.1
153-
>
145+
>
146+
> - **semver:patch**
147+
> SemVer patch update, e.g. &gt; 1.x && 1.0.1 to 1.0.3
148+
>
149+
> - **semver:minor**
150+
> SemVer minor update, e.g. &gt; 1.x && 2.1.4 to 2.3.1
151+
>
154152
> To allow `prereleases`, the corresponding `prepatch`, `preminor` and `premajor` types are also supported
155153

156154
###### Defaults
@@ -172,22 +170,22 @@ However, **`in_range` is not supported yet**.
172170

173171
1. Parsing of *version ranges* is not currently supported
174172

175-
<!-- end list -->
173+
<!-- -->
176174

177175
Update stone requirement from ==1.* to ==3.*
178176
requirements: update sphinx-autodoc-typehints requirement from <=1.11.0 to <1.12.0
179177
Update rake requirement from ~> 10.4 to ~> 13.0
180178

181-
1. Parsing of non semver numbering is not currently supported
179+
2. Parsing of non semver numbering is not currently supported
182180

183-
<!-- end list -->
181+
<!-- -->
184182

185183
Bump actions/cache from v2.0 to v2.1.2
186184
chore(deps): bump docker/build-push-action from v1 to v2
187185

188-
1. Sometimes Dependabot does not include the "from" version, so version comparison logic is impossible:
186+
3. Sometimes Dependabot does not include the "from" version, so version comparison logic is impossible:
189187

190-
<!-- end list -->
188+
<!-- -->
191189

192190
Update actions/setup-python requirement to v2.1.4
193191
Update actions/cache requirement to v2.1.2

0 commit comments

Comments
 (0)