embark icon indicating copy to clipboard operation
embark copied to clipboard

Release list doesn't mention removed features

Open unhammer opened this issue 4 years ago • 4 comments

I was depending on embark-overriding-keymap, then it disappeared without any mention in https://github.com/oantolin/embark/releases and there's nothing about removed features in the main readme either; it would be nice with an UPGRADING section somewhere of deprecated/removed features.

unhammer avatar Oct 29 '21 11:10 unhammer

There was a lot of churn recently and the package is still young. If you rely on special features, there is no way around reading the code. See https://github.com/oantolin/embark/commit/d687aa100218509c20f95e1e1f99b1923d431619 for the relevant commit. There is a workaround and nothing was lost as far as I can tell.

minad avatar Oct 29 '21 11:10 minad

I'm sorry about this! Does the recipe in the wiki serve as an adequate replacement for your usage of embark-overriding-keymap?

oantolin avatar Oct 30 '21 21:10 oantolin

Thanks, that page helped :)

(To be clear, I'm not saying I need the old feature, just saying it'd be nice to have a fairly accessible way of finding a list about how to upgrade / what is deprecated. But I understand it's a bit early in the progress – perhaps this issue should be saved for when embark is closer to 1.0, feel free to close and ignore ;))

unhammer avatar Oct 31 '21 07:10 unhammer

There is a News section I sometimes but at the beginning of the README, but a more formal and append-only changelog would be better.

oantolin avatar Oct 31 '21 16:10 oantolin

I agree that the readme should contain a changelog for the updates in each released version. As a user, I'm excited about the new paradigm this package provides, and the development in each version may bring new features and power, but it's not practical for a user to review the git log for each release to find out, e.g. what new commands or options are available.

alphapapa avatar Feb 24 '23 16:02 alphapapa

I finally started a changelog.

oantolin avatar Apr 23 '23 18:04 oantolin