diff --git a/README.md b/README.md
index 46204e8..d9a7ec6 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
- ... a github action that builds your release notes fast, easy and exactly the way you want.
+ ... a GitHub action that builds your release notes fast, easy and exactly the way you want.
@@ -57,11 +57,11 @@ Specify the action as part of your GitHub actions workflow:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
-By default the action will try to automatically retrieve the `tag` from the current commit and automtacally resolve the `tag` before. Read more about this here.
+By default the action will try to automatically retrieve the `tag` from the current commit and automatically resolve the `tag` before. Read more about this here.
### Action outputs
-After action execution it will return the `changelog` and additional information as step output. You can use it in any follow up step by referenceing the output by referencing it via the steps id. For example `build_changelog`.
+After action execution it will return the `changelog` and additional information as step output. You can use it in any follow-up step by referencing the output by referencing it via the id of the step. For example `build_changelog`.
```yml
# ${{steps.{CHANGELOG_STEP_ID}.outputs.changelog}}
@@ -167,7 +167,7 @@ This configuration is a `.json` file in the following format.
}
```
-Any section of the configuration can be ommited to have defaults apply.
+Any section of the configuration can be omitted to have defaults apply.
Defaults for the configuration can be found in the [configuration.ts](https://github.com/mikepenz/release-changelog-builder-action/blob/develop/src/configuration.ts)
@@ -175,7 +175,7 @@ Please see the [Configuration Specification](#configuration-specification) for d
### Advanced workflow specification
-For advanced usecases additional settings can be provided to the action
+For advanced use cases additional settings can be provided to the action
```yml
- name: "Complex Configuration"
@@ -194,19 +194,19 @@ For advanced usecases additional settings can be provided to the action
💡 All input values are optional. It is only required to provide the `token` either via the input, or as `env` variable.
-| **Input** | **Description** |
-|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| configuration | Relative path, to the `configuration.json` file, providing additional configurations |
-| owner | The owner of the repository to generate the changelog for |
-| repo | Name of the repository we want to process |
-| fromTag | Defines the 'start' from where the changelog will consider merged pull requests |
-| toTag | Defines until which tag the changelog will consider merged pull requests |
-| path | Allows to specify an alternative sub directory, to use as base |
-| token | Alternative config to specify token. You should prefer `env.GITHUB_TOKEN` instead though |
-| ignorePreReleases | Allows to ignore pre-releases for changelog generation (E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick). Only used if `fromTag` was not specified. Default: false |
-| failOnError | Defines if the action will result in a build failure, if problems occurred. Default: false |
+| **Input** | **Description** |
+|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `configuration` | Relative path, to the `configuration.json` file, providing additional configurations |
+| `owner` | The owner of the repository to generate the changelog for |
+| `repo` | Name of the repository we want to process |
+| `fromTag` | Defines the 'start' from where the changelog will consider merged pull requests |
+| `toTag` | Defines until which tag the changelog will consider merged pull requests |
+| `path` | Allows to specify an alternative sub directory, to use as base |
+| `token` | Alternative config to specify token. You should prefer `env.GITHUB_TOKEN` instead though |
+| `ignorePreReleases` | Allows to ignore pre-releases for changelog generation (E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick). Only used if `fromTag` was not specified. Default: false |
+| `failOnError` | Defines if the action will result in a build failure if problems occurred. Default: false |
-💡 `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repos please use a PAT (Personal Access Token).
+💡 `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repositories please use a PAT (Personal Access Token).
### PR Template placeholders
@@ -242,12 +242,12 @@ Table of descriptions for the `configuration.json` options.
|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| categories | An array of `category` specifications, offering a flexible way to group changes into categories |
| category.title | The display name of a category in the changelog |
-| category.labels | An array of labels, to match pull request label against. If any PR label, matches any category label, the pull request will show up under this category |
+| category.labels | An array of labels, to match pull request labels against. If any PR label, matches any category label, the pull request will show up under this category |
| sort | The sort order of pull requests. [ASC, DESC] |
| template | Specifies the global template to pick for creating the changelog. See [Template placeholders](#template-placeholders) for possible values |
| pr_template | Defines the per pull request template. See [PR Template placeholders](#pr-template-placeholders) for possible values |
| empty_template | Template to pick if no changes are detected. Does not support placeholders |
-| transformers | An array of `transform` specification, offering a flexible API to modify the text per pull request. This is applied on the change text created with `pr_template`. `transformers` are executed per change, in the order specified |
+| transformers | An array of `transform` specifications, offering a flexible API to modify the text per pull request. This is applied on the change text created with `pr_template`. `transformers` are executed per change, in the order specified |
| transformer.pattern | A `regex` pattern, extracting values of the change message. |
| transformer.target | The result pattern, the regex groups will be filled into. Allows for full transformation of a pull request message. Including potentially specified texts |
| max_tags_to_fetch | The maximum amount of tags to load from the API to find the previous tag. Loaded paginated with 100 per page |
@@ -271,7 +271,7 @@ $ npm test
$ npm run lint -- --fix
```
-It's suggested to export the token to your path before running the tests, so that API calls can be done to github.
+It's suggested to export the token to your path before running the tests so that API calls can be done to GitHub.
```bash
export GITHUB_TOKEN=your_personal_github_pat