-
-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e1037c9
commit 9b0eb6b
Showing
5 changed files
with
15 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,5 +5,5 @@ | |
"packages": [ | ||
"packages/*" | ||
], | ||
"version": "0.0.0" | ||
"version": "1.0.0" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,58 +38,8 @@ Here the recommended workflow to generate your changelog file using `gitmoji-cha | |
6. Tag your release: `git tag -a v1.0.0 -m "v1.0.0"` (or create a Github release) | ||
7. Push to the remote `git push` | ||
|
||
## Customize your changelog | ||
|
||
By default when you generate your changelog with `gitmoji-changelog`, the following mapping is used to group commits : | ||
> [groupMapping.js](packages/gitmoji-changelog-core/src/groupMapping.js). | ||
*// TODO: How to override the default mapping with it's own.* | ||
|
||
## Usage | ||
|
||
### CLI | ||
|
||
Full CLI documentation in [gitmoji-changelog-cli package](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-cli#gitmoji-changelog-cli) | ||
|
||
### API | ||
|
||
Full API documentation in [gitmoji-changelog-core package](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-core#gitmoji-changelog-core) | ||
|
||
## Develop and contribute | ||
|
||
### Setup | ||
|
||
```bash | ||
git clone [email protected]:frinyvonnick/gitmoji-changelog.git | ||
|
||
cd gitmoji-changelog && yarn | ||
``` | ||
|
||
We are using lerna and yarn workspaces to split the library in modules: | ||
- [gitmoji-changelog-cli](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-cli) - the full-featured command line interface | ||
- [gitmoji-changelog-core](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-core) - the core lib generating changelog | ||
- [gitmoji-changelog-markdown](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-markdown) - the markdown changelog file writer | ||
|
||
**Execute it locally:** | ||
|
||
``` | ||
node [path-to-gitmoji-changelog-folder]/packages/gitmoji-changelog-cli/src/index.js | ||
``` | ||
|
||
**Execute tests:** | ||
|
||
We are using [jest](https://jestjs.io/) to manage unit testing. | ||
|
||
```bash | ||
yarn test | ||
# or | ||
yarn test --watch | ||
``` | ||
|
||
**Execute linter:** | ||
|
||
We are using [airbnb-base](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base) as linter: | ||
|
||
```bash | ||
yarn lint | ||
```js | ||
gitmoji-changelog --help | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters