Skip to content

Commit

Permalink
style: format file
Browse files Browse the repository at this point in the history
  • Loading branch information
marcocesarato committed Jan 24, 2021
1 parent 0424e1f commit ecce109
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 33 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,21 @@

## Description

Generate changelogs from a project's commit messages and metadata using composer and automate versioning with [semver](https://semver.org) and [conventional-commits](https://conventionalcommits.org).
Generate changelogs from a project's commit messages and metadata using composer and automate versioning
with [semver](https://semver.org) and [conventional-commits](https://conventionalcommits.org).

This package can generate changelog and release notes from committing history.
It provides a command that can be run from the terminal, or using composer scripts, to generate a changelog file in markdown for the current project.
This package can generate changelog and release notes from committing history. It provides a command that can be run
from the terminal, or using composer scripts, to generate a changelog file in markdown for the current project.

The command may take parameters that define the releases of the project that will be considered to extract the changes from the git history to generate the file.
The package uses a configuration system with that permit to customize the settings you may want to have your desired changelog generated.
The command may take parameters that define the releases of the project that will be considered to extract the changes
from the git history to generate the file. The package uses a configuration system with that permit to customize the
settings you may want to have your desired changelog generated.

### How to contribute

Have an idea? Found a bug? Please raise to [ISSUES](https://github.com/marcocesarato/php-conventional-changelog/issues) or [PULL REQUEST](https://github.com/marcocesarato/php-conventional-changelog/pulls).
Contributions are welcome and are greatly appreciated! Every little bit helps.
Have an idea? Found a bug? Please raise to [ISSUES](https://github.com/marcocesarato/php-conventional-changelog/issues)
or [PULL REQUEST](https://github.com/marcocesarato/php-conventional-changelog/pulls). Contributions are welcome and are
greatly appreciated! Every little bit helps.

## 📖 Installation

Expand Down Expand Up @@ -63,7 +66,8 @@ Now you can just run `composer changelog` to generate your changelog.

> **Notes:** this procedure is *optional* and permit to overwriting/merging the default settings
For customize settings you just neet to create a file named `.changelog` on the root of your project or on the working dir.
For customize settings you just neet to create a file named `.changelog` on the root of your project or on the working
dir.

> **Notes:**<br>
> - If you don't need to customize some settings just omit it from the configuration file
Expand All @@ -73,6 +77,7 @@ For customize settings you just neet to create a file named `.changelog` on the
Configure your preferences with the help of the following example.

#### Config Example

```php
<?php
return [
Expand All @@ -94,7 +99,7 @@ return [
],
],
// Exclude not notables types (following types are the default excluded types)
'ignoreTypes' => ['build', 'chore', 'ci', 'docs', 'refactor', 'revert', 'style', 'test'],
'ignoreTypes' => ['build', 'chore', 'ci', 'docs', 'pref', 'refactor', 'revert', 'style', 'test'],
'ignorePatterns' => [
// Exclude all commits with this message
'chore(deps): update dependencies',
Expand All @@ -106,8 +111,8 @@ return [

## 💻 Usage

The changelog generator will generate a log of changes from the date of the last tag to the current date,
and it will put all commit logs in the latest version just created.
The changelog generator will generate a log of changes from the date of the last tag to the current date, and it will
put all commit logs in the latest version just created.

![](docs/images/usage.gif)

Expand All @@ -119,7 +124,6 @@ and it will put all commit logs in the latest version just created.
> - `PATCH`: Default
> - Use these options to specify the release method: `--major`, `--minor`, `--patch`, `--rc`, `--beta`, `--alpha`.

### Examples

#### First version
Expand All @@ -132,7 +136,6 @@ To generate your changelog for the first version run:
php vendor/bin/conventional-changelog --first-release
```


#### New version

To generate your changelog *(without committing files)*
Expand Down Expand Up @@ -181,7 +184,6 @@ To generate your changelog from a specified tag to another specified tag
php vendor/bin/conventional-changelog --from-tag="v1.0.2" --to-tag="1.0.4"
```


#### Specific version

To generate your changelog with a specific version code
Expand Down
38 changes: 19 additions & 19 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
- Commit all changed files (`--commit-all`)
- Check version history on semver code generator
- Settings
- Hooks
- `preRun`/`postRun`
- `preBump`/`postBump`
- `preChangelog`/`postChangelog`
- `preCommit`/`postCommit`
- `preTag`/`postTag`
- Skips
- `skipBump`
- `skipChangelog`
- `skipCommit`
- `skipTag`
- Tag prefix and suffix (default prefix `v`)
- Show References (default `true`)
- Show Commit hash (default `true`)
- Prettify Scope (default `true`)
- Commit Url Format
- Compare Url Format
- Issue Url Format
- Release Commit Message Format
- Hooks
- `preRun`/`postRun`
- `preBump`/`postBump`
- `preChangelog`/`postChangelog`
- `preCommit`/`postCommit`
- `preTag`/`postTag`
- Skips
- `skipBump`
- `skipChangelog`
- `skipCommit`
- `skipTag`
- Tag prefix and suffix (default prefix `v`)
- Show References (default `true`)
- Show Commit hash (default `true`)
- Prettify Scope (default `true`)
- Commit Url Format
- Compare Url Format
- Issue Url Format
- Release Commit Message Format

0 comments on commit ecce109

Please sign in to comment.