search

jscutlery / semver

Nx plugin to automate semantic versioning and CHANGELOG generation.
MIT License
726 stars 84 forks source link

Feature Request: Add a flag to not include the Git tag reference in the change log #562

Open Chowarmaan opened 2 years ago

Chowarmaan commented 2 years ago

When generating the CHANGELOG.md, I would like to be able to not add the Git references to the document.

For instance, I have the following generated by semver (the highlighted part is what I would want to suppress with the new option):

[timesheet-api]  Calculated new version "0.2.0".

---
## [0.2.0](https://.../compare/timesheet-api-0.1.0...timesheet-api-0.2.0) (2022-07-07)

### Features

* **timesheet-api:** add a /metrics endpoint with Prometheus data ([7150594](.../commit/7150594277a3e1d446d15930567cbff3086809ed))
* **timesheet-api:** add the /healthz health check with terminus for NestJS ([7c5a1bc](https://.../commit/7c5a1bcfa010a81dad13cd7cb855217a8d10f510))

### Bug Fixes

* **timesheet-api:** add the OPTIONS method to /api for the health check to validate http is up ([74260b9](https://.../commit/74260b90228fcb9b56255c0f8c96521c10106ecf))
* **timesheet-api:** correct the database configuration to be supported with the TypeORM migrations ([18d03b2](https://.../commit/18d03b277ce42a387ad2b1c89488a9910257555a))
* **timesheet-api:** correct the database connection information ([513ac27](https://.../commit/513ac274159dd249e82841ca21879b7051a383ac))
---

which would then generate:

[timesheet-api]  Calculated new version "0.2.0".

---
## [0.2.0](https://.../compare/timesheet-api-0.1.0...timesheet-api-0.2.0) (2022-07-07)

### Features

* **timesheet-api:** add a /metrics endpoint with Prometheus data
* **timesheet-api:** add the /healthz health check with terminus for NestJS

### Bug Fixes

* **timesheet-api:** add the OPTIONS method to /api for the health check to validate http is up
* **timesheet-api:** correct the database configuration to be supported with the TypeORM migrations 
* **timesheet-api:** correct the database connection information 
---
edbzn commented 2 years ago

This would need to be able to customize the output of the changelog generation, note that actually, we rely on conventional-changelog.

Chowarmaan commented 2 years ago

Ok. I did see information in conventional-changelog, around issue https://github.com/conventional-changelog/conventional-changelog/issues/102, which has to do with long/short hashes, but more importantly how the writer options work, which might be able to handle this?