Introduce changelog file #34
Conversation
jesusreal
requested review from
kazydek,
klaudiagrz and
tomekpapiernik
as code owners
jesusreal
requested review from
antiheld,
dariadomagala-sap,
hardl,
kwiatekus,
maxmarkus,
pekura and
y-kkamil
as code owners
CHANGELOG.md
Outdated
| Generate changelog using lerna-changelog tool. | ||
|
|
||
|
|
||
| Types of changes are detected based on PR labels and are mapped to sections as per configuration in the package.json |
There was a problem hiding this comment.
The lerna-changelog tool detects changes based on PR labels and maps them to sections as per the configuration in the package.json file.
CHANGELOG.md
Outdated
| <!-- #and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). --> | ||
|
|
||
| <!-- | ||
| Generate changelog using lerna-changelog tool. |
There was a problem hiding this comment.
Generate the changelog using the lerna-changelog tool.
CHANGELOG.md
Outdated
| @@ -0,0 +1,83 @@ | |||
| # Changelog | |||
|
|
|||
| <!-- , --> | |||
CHANGELOG.md
Outdated
| # Changelog | ||
|
|
||
| <!-- , --> | ||
| <!-- #and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). --> |
There was a problem hiding this comment.
Perhaps we can just write: This project adheres to Semantic Versioning: https://semver.org/spec/v2.0.0.html. ? Since it is a comment, markdown formatting is not needed here.
CHANGELOG.md
Outdated
| <!-- | ||
| Generate the changelog the using lerna-changelog tool, i.e | ||
|
|
||
| ./node_modules/lerna-changelog/bin/cli.js --ignoreCommitters (--from core-0.3.0) |
There was a problem hiding this comment.
Generate the changelog the using lerna-changelog tool, i.e ./node_modules/lerna-changelog/bin/cli.js --ignoreCommitters (--from core-0.3.0) -> Generate the changelog using the lerna-changelog tool. For example, ./node_modules/lerna-changelog/bin/cli.js --ignoreCommitters (--from core-0.3.0).
CHANGELOG.md
Outdated
|
|
||
| <!-- | ||
| Generate the changelog using the lerna-changelog tool. | ||
| Run the following command to generate changelog content for pull requests that were merged since the time when the last git tag was created. |
There was a problem hiding this comment.
pull requests that have been merged since (since -> present perfect) and if you say Run the following command I guess it would be better to add the sentence with the : rather than .?
CHANGELOG.md
Outdated
|
|
||
| ./node_modules/lerna-changelog/bin/cli.js --ignoreCommiters | ||
|
|
||
| You can also generate changelog content corresponding to pull requests that were merged in between particular git tags. |
There was a problem hiding this comment.
Same here. Can you finish with the : as well? or add sth like Run this command: after the existing sentence.
* Introduce changelog file
Confirm these statements before you submit your pull request:
Description
Changes proposed in this pull request:
Issue link:
Fixes #48