Installations
npm install changelog.mdDeveloper Guide
Typescript
No
Module System
CommonJS
Min. Node Version
>= 7
Node Version
7.0.0
NPM Version
3.10.8
Score
54.4
Supply Chain
84.7
Quality
69.4
Maintenance
25
Vulnerability
98.1
License
Releases
Unable to fetch releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (100%)
Developer
egoist
Download Statistics
Total Downloads
24,785
Last Day
1
Last Week
5
Last Month
40
Last Year
632
GitHub Statistics
81 Stars
44 Commits
19 Forks
5 Watching
4 Branches
1 Contributors
Bundle Size
368.39 kB
Minified
100.47 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
1.1.0
Package Id
changelog.md@1.1.0
Size
7.02 kB
NPM Version
3.10.8
Node Version
7.0.0
Total Downloads
Cumulative downloads
Total Downloads
24,785
Last day
-80%
1
Compared to previous day
Last week
-68.8%
5
Compared to previous week
Last month
150%
40
Compared to previous month
Last year
-87.3%
632
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
12
changelog.md
How does it work
- Get last version from git tag, if no tags it defaults to
0.0.0 - Get the commits since last version
- Prompt user to enter the type of each commit
- Infer the new version from the types of all commits
- Generate markdown string from commits and prompt answers
- Create or prepend to
CHANGELOG.mdand updatepackage.jsonversion field - Commits changes and create new git tag
Install
1$ yarn global add changelog.md
Usage
1$ changelog
Recipes
Commit types
- patch: Bug fixes
- minor: Backward-compatible updates
- major: Introducing breaking changes
- ignore: Do not include this commit in changelog
Besides choosing ignore in prompts to exclude commits from changelog, the commit message that starts with ignore: will also be excluded.
You can also use format like type: message to pre-define commit type, they will be converted to the commit type we use:
| semantic type | description | commit type | 0.y.z |
|---|---|---|---|
| chore | changes to build process | ignore | |
| docs | documentation only changes | ignore | |
| feat | a new feature | minor | patch |
| fix | bug fix | patch | |
| refactor | code refactor | patch | |
| style | code style changes | ignore | |
| test | add missing tests | ignore | |
| breaking | introduce breaking changes | major | minor |
| perf | performance improvements | patch | |
| tweaks | don't know how to describe | patch |
Note: in 0.y.z versions, major changes will affect y, other changes and patches will affect z. So in such situation you can never reach 1.0.0 do you? Then just explicitly specific the version for your next release, like: changelog 1.0.0
For tweaks: subject, a message with only tweaks or tweak will also be a patch.
You don't have to use these types in your commit message since you can set them one by one when actually running changelog (only for CHANGELOG.md, will not update the commit itself).
Work with npm publish
1# made some changes to your code... 2$ git commit -am "feat: change the world" 3$ npm test 4$ changelog 5$ git push --follow-tags 6$ npm publish
Projects using this
- SAO: ⚔️ Futuristic scaffolding tool.
- docute: 📜 Effortlessly documentation done right.
- welcome to add your project here...
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
Author
changelog.md © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).
egoistian.com · GitHub @EGOIST · Twitter @rem_rin_rin
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
66 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
- Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
- Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
- Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
- Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
- Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
- Warn: Project is vulnerable to: GHSA-p9w8-2mpq-49h9
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
- Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-gqgv-6jq5-jjj9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
- Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
- Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
- Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
Score
1.7
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to changelog.md
changelog-parser
Change log parser for node.
@knapsack/plugin-changelog-md
Add CHANGELOG.md info to Knapsack
github-release-from-changelog
Create GitHub releases from CHANGELOG.md
git-cliff-linux-x64
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️