Add changelog for Drupal 8.2.0

Migrations now automatically find which modules they depend on (aka the unicorn issue at #2560795: Source plugins have a hidden dependency on migrate_drupal before #217 renamed it)

I'll work quickly one stuff around REST

There's #1267508: Subselects don't work in DBTNG conditions, except when used as value for IN been around long enough... or was that 8.3 only at the end? Perhaps #2384459: Add entity query condition for delta in EFQ as well

- Remove white space
- Adding more context to content moderation

Thanks @Gábor Hojtsy, @dawehner, @timmillwood, and @chx!

#1267508: Subselects don't work in DBTNG conditions, except when used as value for IN was 8.3.x only. #2384459: Add entity query condition for delta in EFQ was backported to 8.1.x, but probably could make sense in the 8.2.x CHANGELOG since it wasn't in the 8.1.x ones.

I also tagged #2560795: Source plugins have a hidden dependency on migrate_drupal for the release notes, thanks @chx.

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,44 @@
+- Changed coding standards:
+    * Local variables and parameters can now use camelCase
+    * A blank line is now required after the <?php opening tag

There will be a third one now: #1999722: [policy] Define coding standards for anonymous functions (closures)

1. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,44 @@
   +- Usability improvements:
   +    * Added the Place Block experimental alpha module to place a block on any
   +      page without having to navigate to the backend administration form.
   +    * Added the Outside In experimental alpha module to edit the configuration
   +      of any block on the page.
   +    * Feedback is now provided after creating an entity with a link to it.
   +    * CKEditor dialogs are styled to match Drupal-native dialogs.
   

   I think we should add something here about numerous textual improvements in the UI. (No individual one is worth mentioning, but the aggregate is nice.)

2. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,44 @@
   +- Added a new Content moderation experimental alpha module to define and use
   +  workflow states such as Draft, Archived and Published. (This is a port of the
   +  Workbench Moderation contrib module)
   

   Minor: capitalize "Moderation" and add a period at the end of the last sentence. Edit: And also it needs a serial comma after "Archived".

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,44 @@
+- Improvest REST module and related functionality:

Minor: "Improvest" sounds like an awesome adjective but I think it's a typo? :)

Also, the bullets below this point aren't indented the same as the other bullets.

Making some changes to improve consistency with the 8.1.0 section of the changelog. Still working on it, but here's some work in progress. I have not yet addressed the comments on this issue.

Some more changes. Not all issue comments have yet been addressed, but what do you all think of this structure?

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,60 @@
+- Improved features for building decoupled sites:
+    * Added support for reading (GET) configuration entities as REST resources.
+    * Added dedicated resources for user login, logout and registration.
+    * Added support for selecting an authentication mechanism as part of the
+      configuration of a REST Export Views Display.
+    * Improved the response messages and status codes for requests with missing
+      or incorrect headers.
+- Improved developer APIs:
+    * Added a cors.config service parameter for enabling and configuring
+      Cross-origin resource sharing (CORS).
+    * Simplified REST configuration via per-resource configuration entities and
+      an optional less verbose configuration structure for common cases.
+    * A complete updated entity resource is now returned in the body of a
+      response to a PATCH request.

The line between these 2 categories is pretty blurry. Initially, I thought it'd be clearer. I'm concerned about putting 7+ items into one category since I think that would be too much cognitive load, but I'm open to ideas on if/how to improve this.

Can we be consistent about the vendor libraries by using the full name, the packagist name, or both?

By that I mean:

+- Added vendor libraries:
+    * Stack/Cors (asm89/stack-cors) 1.0.0
+- Updated vendor libraries:
+    * Updated Symfony Routing (symfony/routing) to 1.4.0.

Not sure what that would mean for JS assets, maybe the Drupal libraries machine name if anybody cares. I'm not sure if I care that much about this ;-)

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,60 @@
+- Improved developer APIs:
+    * Added a cors.config service parameter for enabling and configuring
+      Cross-origin resource sharing (CORS).
+    * Simplified REST configuration via per-resource configuration entities and
+      an optional less verbose configuration structure for common cases.
+    * A complete updated entity resource is now returned in the body of a
+      response to a PATCH request.

These are all REST-specific improvements, so I don't think we should separate this out unless we're also going to add all other DX improvements to 8.2.x here as well.

Edit: Also, I consider even "user"-facing REST/API-first improvements to be developer experience, TBH. I'd just include these three in the REST category, because it's unclear what the importance is otherwise. I think a long single list for decoupled sites is a good thing, because then people can see at a glance the things they hated about REST in 8.1.x and go "hey, we're good now, let's use 8.2.x." :)

Overall, the updated patch reads well.

Edit: Also, I consider even "user"-facing REST/API-first improvements to be developer experience, TBH. I'd just include these three in the REST category, because it's unclear what the importance is otherwise. I think a long single list for decoupled sites is a good thing, because then people can see at a glance the things they hated about REST in 8.1.x and go "hey, we're good now, let's use 8.2.x." :)

Yeah, I think some of them are actually a bit borderline. Like CORS is certainly mostly useful in the context of decoupled sites.

Ok, +1 to merging those two sections, per #19.

Here's some additional cleanup for #16 and other minor tweaks.

This adds lines for #3 and #8. I think the only feedback on this issue not yet incorporated is #11.1:

I think we should add something here about numerous textual improvements in the UI. (No individual one is worth mentioning, but the aggregate is nice.)

I'm not familiar with what these improvements were, so not sure how best to summarize them in a single sentence, or which category to put them into. Any ideas?

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,69 @@
+- Improved site administration experience:

I would put it under this category since the majority of them are on administrative pages. Maybe something simple like:

Numerous improvements to user interface text.

https://www.drupal.org/project/issues/search/drupal?project_issue_follow... includes many of the issues.

Maybe we can also include #2513402: Any time a user creates a thing and saves, display a link to the thing created in the status. somewhere? I'd forgotten about that one.

1. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +- Changed coding standards:
   +    * Local variables and parameters can now use camelCase.
   +    * A blank line is now required after the <?php opening tag.
   

   This is missing the closures issue. OTOH that one is currently in limbo because we might not have sufficient support in coder yet.

2. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +- Testing improvements:
   

   I read "Tasting improvements". Seems fitting. ;)

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,69 @@
+    * Feedback is now provided after creating an entity with a link to it.

Hm this point is not really clear. Maybe:
"Whenever a new entity is created, a link to it is provided in a status message, for easy access the new content regardless of the form workflow."

Yeah #25 tripped me up too.

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,69 @@
+    * 404 responses now get a shorter and configurable TTL in the internal page
+      cache, improving the utilization of cache backend resources.

to improve utilization sounds difficult.

What about:

404 responses now are cached for a shorter time by default in the internal page cache, to ensure they don't consume needless space

1. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +      is output to an RSS feed.
   

   is output -> is "to output" a verb?

2. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +    * Feedback is now provided after creating an entity with a link to it.
   

   I read this as "if you create an entity with a link… then you get feedback".

3. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +    * CKEditor dialogs are styled to match Drupal-native dialogs.
   

   s/CKEditor dialogs/CKEditor-native/

   … because this only affects dialogs like those for <table> — the image and link plugins for CKEditor that Drupal includes already use Drupal dialogs. This just improves the 5% case (if even that).

   I honestly don't think this belongs in the changelog.

4. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +- Improved site administration experience:
   +    * 404 responses now get a shorter and configurable TTL in the internal page
   +      cache, improving the utilization of cache backend resources.
   

   I don't see how this affects site administration — it affects scalability.

5. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +      Cross-origin resource sharing (CORS).
   

   Why is "Cross" capitalized, but nothing else? Either nothing, or all words in the "CORS" acronym should be capitalized.

6. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,69 @@
   +    * Improved the response messages and status codes for requests with missing
   +      or incorrect headers.
   

   Should this mention "DX"?

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,69 @@
+- Updated vendor libraries:
+    * Updated to jQuery 2.2.3.
+    * Updated to Twig 1.24.
+    * Updated to Symfony Routing 1.4.0.
+    * Updated to Stack/Builder 1.0.4.

I think CKeditor just got updated too.

Addressed all the feedback since #21.

Except:

• #29.1: I think what's in there as-is, "is output to" is grammatically correct.
• #29.3: I left it in per #2090937-110: Seven theme: style CKEditor-native dialogs to match Drupal-native dialogs, but am fine with others deciding to remove it. Rather than adding "native" to CKEditor, I removed it from "Drupal". I think it's sufficiently unambiguous with the wording in this patch.
• #29.6: We don't use the term "DX" elsewhere in the changelog. Not sure it's worth adding it to that line.

Given that this has been generated from the automatic release notes I can only really assume it is complete. However, nothing is jumping out at me as glaringly missing. I've reviewed the content and also nothing appears to be incorrect.

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,75 @@
+- Improved decoupled site building features:

There's been some discussion about which wording is better. Perhaps Improved REST API and decoupled site building features: encompasses all points.

Addressing #33.

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,75 @@
+      code from uninstalled modules.
+- Improved REST API and decoupled site building features:
+    * Added support for reading (GET) configuration entities as REST resources.

Can we just call this REST? There's nothing in here that's not in the REST module.

+++ b/core/CHANGELOG.txt
@@ -1,3 +1,75 @@
+- Improved performance/scalability:

#2699627: url.path cache context for breadcrumbs is unnecessarily granular was backported to 8.1.x, but if we're mentioning the page cache we could mention this too - resolves the same general issue.

Here are some more:

* Add better logging to BrowserTestBase
* Add a lot of functionality from WebTestCase to BrowserTestBase
* Start of conversion from BrowserTestBase tests to WebTestCase
* Converted all kernel tests to phpunit style kernel tests.

I'll incorporate things for #35 and #36.

Note that compiling this changelog would be a bit easier if we would do #2802947: [meta] Use the Git commit message format from AngularJS.

Then we could pre-compile a list of all changes per module/subsystem automatically from the git log and beautify it from there.

Incorporates the additional suggestions for #35 and #36. I did not change the header for REST. I agree that it's valuable to specifically say "REST improvements" since that's what they are, but I suppose it's also useful to provide more context for a general site-building audience (which is presumably why @effulgentsia changed this in #20). Including both terms per @alexpott's suggestion is probably fine.

@klausi, I don't think that actually helps us because this is a curated list of important changes, not the entire commit log which is hundreds and hundreds of issues long. The curation is the hard part, not the categorization.

1. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,75 @@
   +    * Added support for selecting an authentication mechanism as part of the
   

   s/mechanism/provider/

2. +++ b/core/CHANGELOG.txt
   @@ -1,3 +1,75 @@
   +    * Simplified REST configuration via per-resource configuration entities and
   +      an optional less verbose configuration structure for common cases.
   

   Actually this gets it wrong. The "less verbose configuration structure" is indeed optional, but it's the new default. It's now the original (complex/detailed/verbose) configuration structure that is opt-in.

   So, we changed the default complexity. The old structure is opt-in.

   So, what about this:

   Simplified REST configuration via per-resource configuration entities and less verbose configuration structure — the previous, more advanced structure is still supported
   

@xjm: sure, the final changelog would still be a manually curated list. But in order to actually know what to put in the list you can look at the compiled automatic changelog and it will give you a grouped list of changes. You immediately see in what subsystem many changes happened and it also helps to not forget about things.

Addresses #41.

@catch pointed out that "decoupled site building features" can be misleading because that can be misread as decoupled features for site builders, which is a specific audience we define, rather than as features for building decoupled sites.

Updated "Outside In" to "Settings Tray" with a note on its machine name.

Committed and pushed 380e763 to 8.3.x and efe135b to 8.2.x. Thanks!

Looks like the paragonie/random_compat 2.0.2 vendor change hasn't quite made it yet, the original change was reverted.

https://www.drupal.org/node/2763787

Thanks,

•• matt

@mattlt nice spot! Created #2811357: Fix CHANGELOG.txt for 8.2.0 to remove paragonie/random_compat update

Here's an issue for 8.3.0: #2846830: Add changelog for Drupal 8.3.0