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

Update the release notes README with image instructions #6002

Merged
merged 1 commit into from
Jul 10, 2023
Merged

Update the release notes README with image instructions #6002

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion packages/devtools_app/release_notes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
## Generating Release notes
## Updating NEXT_RELEASE_NOTES.md
When you add a user-facing change to DevTools, please add a release note entry to document this improvement.

If you want to add an image to the release note entry, add the image to the `release_notes/images` folder,
and then reference it in the markdown. For example:

```
![my feature](images/my_feature.png "my feature")
```

When adding these release notes to the Flutter website, you'll have to copy the image over and edit the path
to match the structure of the Flutter website.

## Generating Release notes for the Flutter website
- Release notes for DevTools are hosted on the flutter website (see [archive](https://docs.flutter.dev/tools/devtools/release-notes)).
- To add release notes for the latest release, create a PR with the appropriate changes for your release.
- The [NEXT_RELEASE_NOTES.md](NEXT_RELEASE_NOTES.md) file contains the running release notes for the current version.
Expand Down