-
-
Notifications
You must be signed in to change notification settings - Fork 544
Description
I am reading change log docs and usage examples with release-it
package. Maybe I don't understand it well enough or maybe the way I use change log is a bit different then others.
My workflow is next. I am following the "rules" of Keep a Changelog. During the process of development we (I and my team) manually update the CHANGELOG.md file. I really don't want to have commit logs inside there. Many times commit logs from different developers are just a pure trash. That's why I prefer to have manual entries in CHANGLOG.md file. This way even project managers are able to understand them. Commit logs are too technically deep for them. Okay anyway. Right before a release our CHANGLOG.md file looks something like this (an example):
# Changelog
## [Unreleased]
### Added
- Added support for releasing app with `release-it` package.
### Changed
- Default button colors changed from red to blue.
### Security
- Updated vulnerabe package.
## [5.6.0] - 2020-05-02
### Changed
- The `pipeline` tag does not trigger pipeline and docker build anymore.
### Removed
- The `master` branch was removed. Replaced with `release` branch!
## [5.4.1] - 2020-05-01
### Fixed
- Critical bug breaks the app when submitting the form.
## [5.4.0] - 2020-04-26
### Added
- Just some README instructions.
### Changed
- Index HTML with one more paragraph.
As you can see my release notes are already prepared when I am making a new release and I want to use them. Actually, to be more precise I would love to have 2 things:
- Line with
## [Unreleased]
text to be replaced with## [5.7.0] - 2020-05-05
(so new releasing version and today's date) and committed and pushed alongside with releasing new version. - This section
to be used as GitLab release notes.
### Added - Added support for releasing app with `release-it` package. ### Changed - Default button colors changed from red to blue. ### Security - Updated vulnerabe package.
Is this possible to achieve this workflow with release-it
package or not?