Problem/Motivation

The development recipe drupal/varbase_dev_base belongs with the project template a developer starts a site from, not inside a distributable site-template recipe. It is currently required by the Varbase Starter recipe package, which never applies it.

  • Varbase Dev Base is a development recipe: "A recipe to manage default development modules and configurations. Development Environment Modules, make sure to disable them in production."
  • It installs dblog, views_ui, config_update_ui, devel, sdc_devel and reroute_email, and its Composer package additionally pulls drupal/storybook, drupal/stage_file_proxy, drupal/devel_entity_updates, drupal/config_ignore and drupal/config_update.
  • Pair issue (the other half of this move): #3621019: Remove the Varbase Dev Base dependency from the Varbase Starter recipe composer.json.

Steps to reproduce

  1. Open composer.json on the 11.0.x branch of the Varbase Project Template.
  2. The require section holds composer/composer, composer/installers, cweagans/composer-patches, the five drupal/core-* scaffold packages, drupal/core ~11.4.0, drush/drush ~13, vardot/varbase 11.0.x-dev and vardot/varbase-patches 11.0.x-dev. There is no drupal/varbase_dev_base, and no require-dev section at all.

Proposed resolution

  • Add "drupal/varbase_dev_base": "~1.0.0" to require in composer.json on the 11.0.x branch.
  • The maintainer's decision is require, not require-dev. The consequence: every site created from the Varbase Project Template will ship devel, storybook, reroute_email, stage_file_proxy and devel_entity_updates in production unless the site builder removes them. Site builders should disable or remove the development stack before going to production, which is what the recipe's own description advises.
  • Verification item for the merge request: .gitlab-ci.yml in Varbase Starter notes at around line 493 that drupal/storybook (pulled in through varbase_dev_base) conflicts with a locked symfony/css-selector on a partial update, so --with-all-dependencies was needed. Adding the package to the project template may have lock-resolution implications worth checking when the merge request runs.

Remaining tasks

  • ✅ File an issue
  • ✅ Addition/Change/Update/Fix
  • ✅ Testing to ensure no regression
  • ➖ Automated unit testing coverage
  • ➖ Automated functional testing coverage
  • ➖ UX/UI designer responsibilities
  • ➖ Readability
  • ➖ Accessibility
  • ➖ Performance
  • ➖ Security
  • ➖ Developer Documentation
  • ➖ User Guide Documentation
  • ✅ Reviewed by human
  • ✅ Code review by maintainers
  • ✅ Full testing and approval
  • ✅ Credit contributors
  • ➖ Review with the product owner
  • ✅ Release notes snippet
  • ✅ Release varbase_project-11.0.7

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • The Varbase Project Template now requires drupal/varbase_dev_base, the Varbase development recipe. It is in require, so the development modules (devel, storybook, reroute_email, stage_file_proxy, devel_entity_updates) ship with every project created from the template. Disable or remove them before going to production.
Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

rajab natshah created an issue. See original summary.

  • rajab natshah committed a5249869 on 11.0.x
    feat: #3621020 Add the Varbase Dev Base recipe to the Varbase Project...
rajab natshah’s picture

Issue summary: View changes
Status: Active » Fixed
Issue tags: +varbase_project-11.0.7

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.