https://github.com/superreal/changelog
Creates a YML file with metadata of a change entry
https://github.com/superreal/changelog
Last synced: over 1 year ago
JSON representation
Creates a YML file with metadata of a change entry
- Host: GitHub
- URL: https://github.com/superreal/changelog
- Owner: superReal
- Created: 2018-12-19T20:23:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-15T04:19:28.000Z (over 7 years ago)
- Last Synced: 2025-02-19T17:06:36.124Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# changelog
Creates a YML file with metadata of a change entry. Based on [Enquirer](https://github.com/enquirer/enquirer), the powerful Node.js library for creating interactive CLI prompts.
## DEPRECATED
This package has been moved to [@deptagency/changelog](https://github.com/deptagency/changelog)
### Settings
##### Destination
`./changelog/unreleased/`
##### File format
`%s-%s.yml`
| Value | Description | Slugified |
|--------|-------------------|:----------:|
| `%1$s` | Jira ticket | `true` |
| `%2$s` | Changelog message | `true` |
### Prompt
| Question | Hint | Type |
|-------------------|----------------------------------------|:--------------:|
| Changelog message | ... e.g. Bug ticket title | `text` |
| Type of change | ... use arrow-keys, to submit | `autocomplete` |
| Jira ticket | ... e.g. HD-987 | `text` |
| Merge Request | ... e.g. 790 | `text` |