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.

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

[BUG] Exported configs differ on Playbook and ISLE. #17

Open
rosiel opened this issue Nov 1, 2022 · 2 comments
Open

[BUG] Exported configs differ on Playbook and ISLE. #17

rosiel opened this issue Nov 1, 2022 · 2 comments
Labels
bug Something isn't working

Comments

@rosiel
Copy link
Contributor

rosiel commented Nov 1, 2022

Overview

Playbook and ISLE provide external services that Drupal uses, and their locations (from Drupal's perspective) are configured in configuration entities that are part of the starter site. Example:

ISLE: broker is at tcp://activemq:61613
Playbook: broker is at tcp://127.0.0.1:61613

The Starter Site happens to contain values that match the Playbook, and ISLE includes a code that configures Drupal to point to the services at the ISLE locations. This is not a problem.

However when someone on ISLE wishes to make a PR against the Starter Site. When they do a config:export and git diff, the changes include these changed values. This makes it very hard to encourage people to do pull requests.

I have a document outlining what I think are the available options for this. To summarize it, I think we should duly consider:

  • making ISLE values the standard instead of Playbook
  • letting these values vary commit-to-commit (expect whoever is deploying it to set it up as they want)
  • using Drupal's Config Override (suggested by @adam-vessey ) (in the document i highlight how this negatively affects the site admin experience)
  • using Drupal's Config Split (mentioned by @bibliophileaxe ) (in the document i highlight how this removes entire YAML files from the starter site's management)
  • creating a custom script (Drush or otherwise) to reset the specific set of custom values in a set of exported config
@rosiel rosiel added the bug Something isn't working label Nov 1, 2022
@rosiel
Copy link
Contributor Author

rosiel commented Nov 4, 2022

For current convenience, I wrote a shell script to change ISLE values back to Playbook values. It works on my mac. I don't know how to make it portable, sorry.

@rosiel
Copy link
Contributor Author

rosiel commented Feb 7, 2023

As brought up by @Natkeeran , this is still an issue. I propose that we solve the immediate problem which is:

  • The current preference for the Playbook's values poses a barrier to contributing to the Starter Site using in ISLE.
  • A goal of the Starter Site's architecture is to remove barriers to contributing to the Starter Site, by making it more simple and transparent and straightforward.
  • A lot of the folks doing site configuration and testing are using ISLE because it's simpler than Playbook and/or they've got a cool new Mac computer. (not jealous, I swear).

So I propose this which is not a tech solution, but I prefer it because it keeps things simpler and consistent:

  • We change the default values to the ISLE values.
  • We leave in the step in ISLE where those values are explicitly set using drush config:set (no change!!).
  • We fix the steps in the Playbook where those values are supposed to be being set (some are, some aren't!)
  • We offer a shell script (the opposite of the one above) that sets the Playbook values back to ISLE values. Playbook users can contribute, but they'll have an extra step. Not ideal but I'm not sure who else is developing Starter Site on Playbook other than me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant