Comments (2)
Knope was originally using bullets for changes, but once we started supporting changesets, the generated changelogs became too hard to follow. Since you can put arbitrary Markdown for each change, you can put bullets and code blocks and other things that break the flow unless each change file has a header. There is still some Markdown you can put in changesets which will break the flow of the log (for example, headers), but it's much more flexible. In addition, headers usually result in links in their rendered form (like GitHub releases), so it's easy to point someone at a particular change when answering a question.
Perhaps, though, there's a way to go to a hybrid style, where complex changesets get their own little subsection, but simple changes are summarized as bullets in the top section? So conventional commits would always be bullets, and change files would be bullets as long as there was no content outside the header.
Changes
feat: A feature
fix: A quick fix
---
pizza: patch
---
## Fixed name of the pizza
---
pizza: patch
---
## Fixed size of the pizza
- Big pizzas were too small
- Small pizzas were also too small
> Can never have enough pizza!
Generated Changelog Section
Features
- A feature
Bug fixes
- A quick fix
- Fixed name of the pizza
Fixed size of the pizza
- Big pizzas were too small
- Small pizzas were also too small
Can never have enough pizza!
from knope.
This kind of approach would be amazing!
from knope.
Related Issues (20)
- Allow non-Jira sources for `SwitchBranches`
- Support Dotnet packages HOT 4
- Support docker-compose.{yml, yaml} files
- Support assets for Gitea releases
- Refactor `[gitea]` and `[github]` into a single `[[forges]]` HOT 1
- Add integration tests
- Breaking the Go major-version rule HOT 5
- Feature request: add "get-version" workflow to default config
- Explore using `<Steps>` to clarify tutorials
- New home page
- suggestion: Re-order change type
- bug: Character escape inside `knope.toml:workflows.steps.command` doesn't parse correctly HOT 3
- Disable conventional commits HOT 3
- Fix broken links
- Feature: `Prompt` Step type HOT 3
- Feature: Add `help_text` argument to `knope.toml#workflows`
- Get versions for multiple packages HOT 4
- Override `<number>` when creating a pre-release
- bug: TOML parse error when using `CreatePullRequest` Step HOT 1
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 knope.