The Out-of-the-Box Experience initiative team has been doing amazing work trying to prep Umami for shipping in a tagged release. The profile + theme was already been committed to 8.6.x as of a few weeks ago, but the product management is universally aligned that the sooner we can get this amazing functionality out to people, the better it is for Drupal as a whole, and Drupal 8 adoption specifically.
In a discussion with release managers, however, there were concerns raised about shipping it in 8.5.0 given that it was only committed recently (and after the alpha deadline) which—unlike something like Layout Builder which was committed months previously—doesn't leave much room for widespread testing of functionality ahead of release. This is particularly nervous-making given 8.5 has a very short RC cycle in which to flesh out bugs. Additionally, further inspecting might raise some unknown unknowns, such as #2942589: [policy, no patch] Can we (and to what extent) make changes to experimental profiles during a patch release? (which is a "now known unknown unknown" :D /HT @catch) which would impact in what way the profile could evolve within a tagged release and not diverge too much from 8.6.
A compromise was suggested, and seems to have backing of most of the core committer team, of backporting the profile+theme to 8.5, but marking them "hidden," at least for now. This would still make them available in 8.5, installable via Drush (not for evaluators obviously, but for QA testers), and would let us possibly mark Umami unhidden in a later point release (like 8.5.1) to open them up to their intended audience (evaluators, people new to Drupal, people doing Drupal demos, etc.).
We will keep the profile non-hidden (i.e., shown in the installer) in 8.6.x so that beta testers can easily test the demo by using the development tarball.
Commit instructions
git co 8.5.x
git pull
git log --reverse --pretty=format:'%h' 8.6.x -- core/profiles/demo_umami | xargs git cherry-pick -x
And then apply https://www.drupal.org/files/issues/2943004.4.patch, commit and push as per normal.
Comment | File | Size | Author |
---|---|---|---|
#4 | 2943004.4.patch | 442 bytes | alexpott |
#4 | 2943004.4.test-only.patch | 1.8 MB | alexpott |
|
Comments
Comment #2
xjmAdding a bit to the summary about the dev tarball; this change would be 8.5.x-only.
Comment #3
alexpottTo cherry pick all the commits to the umami profile from 8.6.x to 8.5.x you can run the following command on the 8.5.x branch from the root directory.
git log --reverse --pretty=format:'%h' 8.6.x -- core/profiles/demo_umami | xargs git cherry-pick -x
Comment #4
alexpottHere's a patch that does #3 and hides the profile to test that tests pass with the profile hidden.
Another patch attached to just hide the profile. Not tested because it won't apply to 8.5.x on its own.
Comment #5
alexpottThe only commit that is picked that has affected more than just umami is #2939940: Update stylelint rules color-hex-case to be consistent with Drupal's CSS standards and that was backported to 8.5.x so cherry picking that make sense as it will only affect the umami profile.
Comment #6
alexpottYay the tests passed. I've looked in the test log and confirmed that the umami tests ran as expected. Added commit instruction to the issue summary.
Comment #7
alexpottHere's a list of changed files:
The changes outside
core/profiles/demo_umami
are test changes to make them pass now umami is here and the change to the installer to hard-code the warning.Comment #8
alexpottThe commits included in #4 are:
Comment #9
catchJust to confirm I proposed this as the lowest-risk way to get Umami into 8.5.x, and xjm seconded it. Let's us have the codebase in-line and defer exactly how we launch things to not this week.
Comment #10
smazManually testing this:
Code base:
All code has been brought across, it appears no code/commits have been missed.
Installer:
Umami is not available to select. When removing the hidden setting that has been added, it does show up & the warning when the profile is selected works as expected.
Umami successfully installs via Drush.
Default content:
All content & blocks were imported ok
Toolbar warning:
Only visible on the correct pages, and links through to the correct documentation page.
Status report page:
Experimental profile warning present.
Home page:
All expected content present & ok.
Articles listing page:
All as expected.
Article page:
All as expected, including promoted content not including the current article.
Recipes listing page:
All as expected.
Recipe page:
All as expected.
Taxonomy term page:
All as expected,
Search page:
Expected search results returned when searching for 'Vegan' (1 recipe) and 'Carrots' (1 article).
User page:
View / edit tabs present (recent issue that was fixed)
Editing a recipe:
Able to update the content without issue.
Quickedit:
Able to quick edit a recipe without issue.
Anonymous users:
Anonymous users able to access all public sections of the site.
Breadcrumb::
Correct path, containing the current page title as the last item. Includes testing the path on search pages ends with 'Search for [search term]'.
Responsive theming
A quick check, everything appears ok including the responsive hamburger menu.
Menus:
All menu items present.
I'm fairly happy this is the same as it is in 8.6, so happy to RTBC!
Comment #11
smazIf there's commit credits going for reviews, please also add:
jaykandari
eli-t
Both were also reviewing this manually.
Comment #12
alexpottCrediting @smaz for the thorough review and the committers for the release management discussions.
Comment #13
alexpottCommitted d575b05 and pushed to 8.5.x. Thanks!