semantic-release / Changelog
Licence: mit
π semantic-release plugin to create or update a changelog file
Stars: β 142
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Changelog
Semantic Release
π¦π Fully automated version management and package publishing
Stars: β 14,364 (+10015.49%)
Mutual labels: version, release, changelog
Cli
ππ Setup automated semver compliant package publishing
Stars: β 272 (+91.55%)
Mutual labels: version, release, changelog
Bump
Bump updates the project's version, updates/creates the changelog, makes the bump commit, tags the bump commit and makes the release to GitHub. Opinionated but configurable.
Stars: β 327 (+130.28%)
Mutual labels: version, release, changelog
git
π semantic-release plugin to commit release assets to the project's git repository
Stars: β 235 (+65.49%)
Mutual labels: changelog, version, release
Standard Version
π Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org
Stars: β 5,806 (+3988.73%)
Mutual labels: version, release, changelog
perfekt
Release, changelog and version your packages with perfe(k)t π ease!
Stars: β 15 (-89.44%)
Mutual labels: changelog, version, release
Publish Nuget
π¦ GitHub action to automate publishing NuGet packages when project version changes
Stars: β 109 (-23.24%)
Mutual labels: version, release
Chyle
Changelog generator : use a git repository and various data sources and publish the result on external services
Stars: β 137 (-3.52%)
Mutual labels: release, changelog
Npm
π’ semantic-release plugin to publish a npm package
Stars: β 103 (-27.46%)
Mutual labels: version, release
generate-changelog
generates changelog from git based on jira tickets
Stars: β 18 (-87.32%)
Mutual labels: changelog, release
Releaser Tools
Create a GitHub/GitLab/etc. release using a project's commit messages and metadata.
Stars: β 283 (+99.3%)
Mutual labels: release, changelog
Release It
π Automate versioning and package publishing
Stars: β 4,773 (+3261.27%)
Mutual labels: release, changelog
Gh Release
Create a github release for a node package.
Stars: β 132 (-7.04%)
Mutual labels: release, changelog
Python Semver
Python package to work with Semantic Versioning (http://semver.org/)
Stars: β 264 (+85.92%)
Mutual labels: version, release
Docker Changelog Chinese
dockerεζ΄ζ₯εΏδΈζη
Stars: β 107 (-24.65%)
Mutual labels: version, changelog
change
A simple tool that automates generating and updating a changelog
Stars: β 47 (-66.9%)
Mutual labels: changelog, release
Release Notes Generator
π semantic-release plugin to generate changelog content with conventional-changelog
Stars: β 123 (-13.38%)
Mutual labels: release, changelog
Github Release Notes
Node module to create a release or a changelog from a tag and uses issues or commits to creating the release notes.
Stars: β 705 (+396.48%)
Mutual labels: release, changelog
exec
π semantic-release plugin to execute custom shell commands
Stars: β 94 (-33.8%)
Mutual labels: version, release
Git Changelog Lib
Library for parsing and generating a changelog, or releasenotes, from a GIT repository
Stars: β 117 (-17.61%)
Mutual labels: release, changelog
@semantic-release/changelog
semantic-release plugin to create or update a changelog file.
| Step | Description |
|---|---|
verifyConditions |
Verify the changelogFile and changelogTitle options configuration. |
prepare |
Create or update a changelog file in the local project directory with the changelog content created in the generate notes step. |
Install
$ npm install @semantic-release/changelog -D
Usage
The plugin can be configured in the semantic-release configuration file:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
[
"@semantic-release/changelog",
{
"changelogFile": "docs/CHANGELOG.md"
}
],
[
"@semantic-release/git",
{
"assets": ["docs/CHANGELOG.md"]
}
]
]
}
With this example, for each release, a docs/CHANGELOG.md will be created or updated.
Configuration
Options
| Options | Description | Default |
|---|---|---|
changelogFile |
File path of the changelog. | CHANGELOG.md |
changelogTitle |
Title of the changelog file (first line of the file). | - |
Examples
When used with the @semantic-release/git or @semantic-release/npm plugins the @semantic-release/changelog plugin must be called first in order to update the changelog file so the @semantic-release/git and @semantic-release/npm plugins can include it in the release.
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/changelog",
"@semantic-release/npm",
"@semantic-release/git"
]
}
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].