Installations
npm install @release-it/keep-a-changelogDeveloper Guide
Typescript
No
Module System
ESM
Min. Node Version
>=18
Node Version
20.18.0
NPM Version
10.8.2
Score
62.9
Supply Chain
78.2
Quality
78.4
Maintenance
100
Vulnerability
95.3
License
Releases
Contributors
Languages
JavaScript (100%)
Developer
release-it
Download Statistics
Total Downloads
1,442,641
Last Day
1,942
Last Week
10,903
Last Month
59,398
Last Year
612,080
GitHub Statistics
28 Stars
63 Commits
15 Forks
6 Watching
2 Branches
13 Contributors
Bundle Size
27.99 kB
Minified
8.61 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
6.0.0
Package Id
@release-it/keep-a-changelog@6.0.0
Unpacked Size
28.54 kB
Size
6.40 kB
File Count
8
NPM Version
10.8.2
Node Version
20.18.0
Publised On
07 Jan 2025
Total Downloads
Cumulative downloads
Total Downloads
1,442,641
Last day
-31.9%
1,942
Compared to previous day
Last week
-40.8%
10,903
Compared to previous week
Last month
28.3%
59,398
Compared to previous month
Last year
12.6%
612,080
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Peer Dependencies
1
Dev Dependencies
5
Keep-a-changelog plugin for release-it
This release-it plugin maintains your CHANGELOG.md file according to the Keep A Changelog standards.
It updates the changelog automatically by:
- replacing the
## [Unreleased]header with the current version and release date. - [optionally] adding a new
## [Unreleased]header as preparation for future changes.
It does not automatically populate the changelog with commit messages from the git history!
The idea and initial implementation comes from @eMarek.
npm install --save-dev @release-it/keep-a-changelog
In release-it config:
1"plugins": { 2 "@release-it/keep-a-changelog": { 3 "filename": "CHANGELOG.md" 4 } 5}
Options
| option | default value | description |
|---|---|---|
| filename | 'CHANGELOG.md' | File with changelogs. |
| addUnreleased | false | It leaves "Unreleased" title row if set to true. |
| keepUnreleased | false | It leaves "Unreleased" title row unchanged if set to true. |
| addVersionUrl | false | Links the version to the according changeset. Uses GitHub-compatible URLs by default, see other options to configure the URL format. |
| versionUrlFormats | See below. | Determines the version URL format when addVersionUrl is set to true. Uses GitHub-compatible URLs by default. |
| head | 'HEAD' | The git revision the new version tag is compared to in the Unreleased URL. |
versionUrlFormats
The URL formats used when addVersionUrl is set to true. Example configuration for a repository in Azure DevOps:
1"plugins": { 2 "@release-it/keep-a-changelog": { 3 "filename": "CHANGELOG.md", 4 "head": "main", 5 "addVersionUrl": true, 6 "versionUrlFormats": { 7 "repositoryUrl": "https://dev.azure.com/...", 8 "unreleasedUrl": "{repositoryUrl}/branchCompare?baseVersion=GT{tagName}&targetVersion=GB{head}", 9 "versionUrl": "{repositoryUrl}/branchCompare?baseVersion=GT{previousTag}&targetVersion=GT{tagName}", 10 "firstVersionUrl": "{repositoryUrl}?version=GT{tagName}" 11 } 12 } 13}
| option | default value | description |
|---|---|---|
| repositoryUrl | 'https://{host}/{repository}' | The format of the repository URL. |
| unreleasedUrl | '{repositoryUrl}/compare/{tagName}...{head}' | The format of the [unreleased] section URL. |
| versionUrl | '{repositoryUrl}/compare/{previousTag}...{tagName}' | The format of a release version URL. |
| firstVersionUrl | '{repositoryUrl}/releases/tag/{tagName}' | The format of the first release version URL, i.e. when no previous tags have been released. |
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
6 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5
Reason
Found 8/30 approved changesets -- score normalized to 2
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/pkg.pr.new.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pkg.pr.new.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/release-it/keep-a-changelog/pkg.pr.new.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pkg.pr.new.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/release-it/keep-a-changelog/pkg.pr.new.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/release-it/keep-a-changelog/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/release-it/keep-a-changelog/test.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:29
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
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
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 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 8 are checked with a SAST tool
Score
4.1
/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 More