Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mpielvitori committed Aug 17, 2020
1 parent d1fd57a commit 16c0ec9
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Semantic release basic usage
# Semantic release with commitlint basic usage

Semantic release automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package.

This removes the immediate connection between human emotions and version numbers, strictly following the [Semantic Versioning](https://semver.org/) specification.

Also with the addition of commit validation with [commitllint](https://commitlint.js.org).
You can check my repo [commitlint-usage](https://github.com/mpielvitori/commitlint-usage) to see several ways of commitlint usage.

## GitLab usage

1. Push access to the remote repository
Expand All @@ -29,6 +32,6 @@ In this project I just log the version to keep it simple `echo "Version -> $(cat
* Configure semantic release taking as an example the [.releaserc.js](.releaserc.js) file.

## References
* [Semantic release Wiki](https://semantic-release.gitbook.io/semantic-release/)
* [Semantic release Wiki](https://semantic-release.gitbook.io/semantic-release)
* [Semantic release project](https://github.com/semantic-release/semantic-release)

* [Commitlint](https://github.com/conventional-changelog/commitlint)

0 comments on commit 16c0ec9

Please sign in to comment.