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.

Sign up for GitHub

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

Jump to bottom

Add a changelog #48

Closed
yvele opened this issue Jul 17, 2023 · 5 comments · Fixed by #56
Closed

Add a changelog #48

yvele opened this issue Jul 17, 2023 · 5 comments · Fixed by #56
Assignees
@JoshuaKGoldberg
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this!

Comments

@yvele
Copy link

yvele commented Jul 17, 2023 •
edited
Loading

Hello, you've recently updated dedent from 0.7.0 to 1.0.2 which means in semver that this new version is major and potentially breaking.

Where can I found your changelog?

Dedent is massively used https://www.npmjs.com/package/dedent

image

The community will highly benefits from having an easy to find changelog (with a copy within https://github.com/dmnd/dedent/releases).

And also please could you also use GitHub relase -> https://github.com/dmnd/dedent/releases that makes it really easy to find. Specially for developers and maintainers like me that deals with hundreds of packages to updates 🙏

Thanks for your awesome work
@yvele
Copy link
Author

yvele commented Jul 17, 2023

At least a manually written one for the v0 -> v1
what is breaking? what changes?

@Haroenv
Copy link
Collaborator

Haroenv commented Jul 17, 2023

I believe the changes are related to the files which are published, but nothing to the functionality

@JoshuaKGoldberg
Copy link
Collaborator

Hiyall - thanks for raising this! Clearly I underestimated how much folks want a real CHANGELOG. Sorry for the lack of clarity!

As @Haroenv said, there are no breaking functionality changes in 1.0. The full list of changes from 0.x to 1.0 are:

  1. Bugfix: enable tab compatbility #28
  2. Mostly build changes, should not change runtime: build: re-run build to refresh dist/dedent.js #38
  3. Mostly build changes, should not change runtime: build: publish ESM and .d.ts #32
  4. Fixed runtime module exports to not have a breaking change: fix: add babel-plugin-add-module-exports #40

Will add one soon - #36 has a list of steps I'm taking, which include adding automatic generation that cross-posts to GitHub releases. 👍

@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jul 17, 2023
@JoshuaKGoldberg JoshuaKGoldberg added the area: tooling Managing the repository's maintenance label Jul 17, 2023
@JoshuaKGoldberg
Copy link
Collaborator

#55 is pretty big. I'll add a manually written CHANGELOG.md in the meantime.

@JoshuaKGoldberg JoshuaKGoldberg added the status: accepting prs Please, send a pull request to resolve this! label Jul 17, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jul 17, 2023
Merged
JoshuaKGoldberg added a commit that referenced this issue Jul 17, 2023
@JoshuaKGoldberg
docs: added small manual CHANGELOG.md (#56)
26c8235 
#55 will add more infrastructure to auto-generate a nicer file. In the
meantime, this adds the last few months of changes (since I started
working on this repo).

Fixes #48.
@JoshuaKGoldberg
Copy link
Collaborator

Aside: I added the last few versions to dmnd/dedent/releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: added small manual CHANGELOG.md dmnd/dedent
3 participants
@JoshuaKGoldberg @yvele @Haroenv