Skip to content

Commit

Permalink
Merge pull request #48 from saadmk11/doc-update
Browse files Browse the repository at this point in the history
Make it Clear what actions can be performed by Changelog CI in the README
  • Loading branch information
saadmk11 authored Apr 6, 2021
2 parents 7c8f4c0 + 7af6c67 commit 97d1a39
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@
Changelog CI is a GitHub Action that enables a project to utilize an
automatically generated changelog.

The workflow can be configured to perform any (or all) of the following actions
The workflow can be configured to perform **any (or all)** of the following actions

* **Prepend** each update to the `CHANGELOG.md` file.
* **Prepend** the generated changelog to the `CHANGELOG.md` file and then **Commit** modified `CHANGELOG.md` file to the release pull request.

* **Commit** the modified `CHANGELOG.md` file.

* **Write** updates to the `CHANGELOG.md` file, and submit the pull request of the corresponding release version.
* Add a **Comment** on the release pull request with the generated changelog.

## How Does It Work:

Expand All @@ -27,7 +25,7 @@ available). Then, it checks all the pull requests merged after the last release
using the GitHub API. After that, it parses the data and generates
the `changelog`. Finally, It writes the generated changelog at the beginning of
the `CHANGELOG.md` (or user-provided filename) file. In addition to that, if a
user provides a config (JSON file), Changelog CI parses the user-provided config
user provides a config (JSON/YAML file), Changelog CI parses the user-provided config
file and renders the changelog according to users config. Then the changes
are **committed** and/or **commented** to the release Pull request.

Expand Down Expand Up @@ -67,6 +65,7 @@ your `.github/workflows/workflow.yml` file:
# Optional, only required when you want more customization
# e.g: group your changelog by labels with custom titles,
# different version prefix, pull request title and version number regex etc.
# config file can be in JSON or YAML format.
config_file: changelog-ci-config.json
# Optional, This will be used to configure git
# defaults to `github-actions[bot]` if not provided.
Expand Down Expand Up @@ -104,7 +103,7 @@ by adding a `JSON` or `YAML` config file to the project. For exmaple:
config_file: changelog-ci-config.json
```
* Including `YAML` file `config.yml`:
* Including `YAML` file `changelog-ci-config.yml`:

```yaml
with:
Expand Down

0 comments on commit 97d1a39

Please sign in to comment.