dart-lang / dart-lang/pub-dev

Allow to notify the users about breaking changes and migrations via notice file

Open
#5,063 11 comments 9 reactions 0 assignees View on GitHub
Type: enhancement
Dominant language
Dart
Stars
944
Forks
184
Avg merge
1d 15h
Merged PRs (30d)
12

Description

In the .NET world it is possible to include `readme.txt` file [that gets open while installing new nuget package](https://docs.microsoft.com/en-us/nuget/create-packages/creating-a-package#add-a-readme-and-other-files). It is used to notify about important breaking changes or migration strategy.

I suspect it would be awesome to have this kind of tool working somewhere between `pub.dev`, `pub get` and IDE extensions. I understand that this wouldn't be feature of the `pub.dev` per se, but I couldn't think of a better place to start a discussion about it.

**How I imagine this could work**

The library maintainer could include a new file (e.g. `./notice/notice-1.2.3.md`) that would be opened whenever the package version changes from any lower to `1.2.3`. The version change could be detected based on previous and current `pubspec.lock` entry. This file would either be printed in the console or opened in IDE.

If there are more files between previous and current version, then only open the most recent one.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.