Comments (2)
Ah, the default config simply doesn't render the body text:
renderTypeSection: function (label, commits) {
let text = `\n## ${label}\n`;
commits.forEach((commit) => {
const scope = commit.scope ? `**${commit.scope}:** ` : "";
text += `- ${scope}${commit.subject}\n`;
});
return text;
},
The fix is really simple, just add these lines:
if (commit.body) {
text += `${commit.body}\n`;
}
However, I am not sure if this should be part of the default config. Many commits have a body text with some kind of explanation of what was done, which is not interesting for the changelog. Or it has something like "Closes #14", which also doesn't make sense in the changelog.
So for now I am not making a change to tag-changelog's default config but I'll keep this issue open so people can chime in with their thoughts.
from tag-changelog.
I could add a config option includeCommitBody
which defaults to false
, and add these lines to renderTypeSection
:
if (commit.body && includeCommitBody) {
text += `${commit.body}\n`;
}
So people who want to render the body text would only have to change a single boolean instead of having to overwrite a template.
from tag-changelog.
Related Issues (11)
- If I am submitting a tag for the first time, the code logic will throw an exception HOT 6
- Error: Validation Failed: "already_exists" HOT 4
- how to get the release notes and send it to an email HOT 4
- A quesion need help: ChangeLog only has one HOT 1
- Update to Node 16 HOT 1
- Stop using set-output HOT 2
- Not working with merge commits? HOT 4
- Tags from Octokit are sorted alphabetically, possibly causing problems for this action HOT 16
- failed to read commits between previous and new tag HOT 3
- Update to node 20
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 tag-changelog.