Skip to content

M45 Core release notes #2537

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

Merged
merged 1 commit into from
Mar 13, 2019
Merged

M45 Core release notes #2537

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
5 changes: 5 additions & 0 deletions Firebase/Core/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Unreleased

# 2019-03-19 -- v5.4.0 -- M45
- [changed] Allow Bundle IDs that have a valid prefix to enable richer extension support. (#2515)
- [changed] Convert FIRLogger to use the recommended os_log for logging via GoogleUtilities.
See https://developer.apple.com/documentation/os/logging?language=objc.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: did you want to add PR number(s) here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don’t do this indiscriminately.

Issue numbers are useful in release notes because they help affected users understand that a fix is for them. Unaffected users might go there to understand the context of the change more deeply.

PR numbers are just showing how the sausage is made.

A few cases where it might be appropriate to include PR numbers:

  • PRs from third parties elevate that acknowledge their contribution
  • PRs where there’s been a meaningful interaction where someone outside the team has interacted with it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me, thanks @wilhuff for the thoughtful note.

Do you think there's a difference of including them here vs including them in the release notes on the Firebase site? I can see that's a strong case for not including them on the Firebase site but including them here could be helpful for those more curious since they're already in the repo itself.

I don't have super strong feelings about including them here, but wasn't sure if they'd cause much harm.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, there was a series of PR's, so it would be difficult to associate even if we wanted to.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyone sufficiently curious can git log master so our goal should be to help less interested parties establish context on changes without unnecessarily inflicting the development process on them.


# 2019-01-22 -- v5.2.0 -- M41
- [changed] Added a registerInternalLibrary API. Now other Firebase libraries register with FirebaseCore
instead of FirebaseCore needing all of its clients' versions built in.
Expand Down