Comments (3)
The package.json
should only be small, e.g.:
{
"name": "example",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@release-it/conventional-changelog": "^1.1.0"
}
}
The lockfile (package-lock.json
) can be large indeed, like the number of directories in node_modules
. All of this is handled by npm. The dependencies of this project also have sub-dependencies, etc.
from conventional-changelog.
Thank you, for now I added a minimal package.json as you suggested, then kept the hook
"hooks": {
"after:bump": "npx auto-changelog -p"
},
and removed the plugin code
"plugins": {
"@release-it/conventional-changelog": {
"preset": "cli",
"infile": "CHANGELOG.md"
}
In my release-it.json
I still need to understand the difference between
"git": {
...
"changelog": "npx auto-changelog --stdout --commit-limit false -u --template ./.changelog.hbs"
}
and
"hooks": {
"after:bump": "npx auto-changelog -p"
}
For a humble feedback I suggest to make clear in the docs for non-JS projects since not everybody work daily with JS and it could be not obvious what/where to add artifacts.
from conventional-changelog.
The git.changelog
command should return the Git changelog and this will be used for two things:
- Show on the command-line the changelog to help selecting a next version
- Use it as release notes when doing a GitHub or GitLab release (unless e.g.
github.releaseNotes
is used to override this).
The hook command auto-changelog -p
is executing auto-changelog to update the CHANGELOG.md
file (which you could also do with the @release-it/conventional-changelog
plugin by setting its infile
option).
I've also updated the documentation a bit (https://github.com/release-it/release-it/blob/master/docs/github-releases.md#release-notes). Thanks!
from conventional-changelog.
Related Issues (20)
- Aggregate all the pre releases HOT 1
- Option to edit the changelog while releasing HOT 4
- Update conventional-changelog Dependency to Support Changelog Section Sort Order HOT 5
- Update peer deps to `release-it` v16 HOT 1
- semver version should be bumped to fix CVE HOT 5
- How to combine submodule's release note into parent repo's release note? HOT 1
- Error in version 7.0.1: `createPreset` is not a function. HOT 16
- Undefined error in v7.0.1 HOT 2
- Error with conventionalcommits preset HOT 3
- releaseCount not work HOT 4
- ERROR The "angular" preset does not export a function. HOT 2
- issues with changelog modifcation behavior HOT 8
- Customizing types seems to not do anything HOT 2
- Compare-Link in CHANGELOG.md broken HOT 4
- `tagPrefix` not working HOT 1
- link of commit is wrong HOT 1
- the link of compare tags is wrong HOT 3
- [Question] Bump version before 1.0.0 HOT 1
- generate new CHANGELOG.md file for previous changelogs HOT 2
- Commits duplicate under new release versions in CHANGELOG.md HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from conventional-changelog.