Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature request] "changeset" support #135

Open
3 tasks
Hebilicious opened this issue Jul 28, 2023 · 0 comments
Open
3 tasks

[feature request] "changeset" support #135

Hebilicious opened this issue Jul 28, 2023 · 0 comments

Comments

@Hebilicious
Copy link
Member

Hebilicious commented Jul 28, 2023

Describe the feature

Motivation

It would be great if changelogen had the ability to support an optional "changeset" feature. This would allow automated changelog and release logs to include more detailed information about changes. This information can be written for each PR using a markdown file.

Details :

Here's how this could work :

  1. When making a PR, add a .changelogen/[generated-name].md using the changelogen cli.
  2. In this file, write a markdown description of the change.
  3. When a release is made, the changelogen cli add these changes into each package CHANGELOG.md, and delete the "changesets".
  4. The release text is pre-populated with each "changeset" and can be manually modified.

Proposed Format :

Changeset

---
'@nuxt/kit': PRID / commitHash
---

Here we can write a more *detailed* change, using markdown formatting.
| 1 | 2 | 3 |
|---|---|---|
| We | can use | tables |  

Changelog with changeset

🚀 Enhancements

- First Change (https://github.com/unjs/changelogen/pull/123)

- Second Change (https://github.com/unjs/changelogen/pull/123)

	Here we can write a more *detailed* change, using markdown formatting.
	| 1 | 2 | 3 |
	|---|---|---|
	| We | can use | tables |  

- Third Change (https://github.com/unjs/changelogen/pull/123))

Related issues

#85 For monorepo support this is able to correctly move the changeset text into each package changelog.
#91 This must be connected to pre-releases
#104 This must be integrated with a github app/action

Additional information

  • Would you be willing to help implement this feature?

Tasks

  1. aa900031
  2. enhancement
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant