Contrib.social

generate-theme creates starter kit theme using VERSION (which is only for core)

Open on Drupal.org →
Created on 18 April 2023, almost 2 years ago

Problem/Motivation

If you use php core/scripts/drupal generate-theme to generate a starter kit theme, you end up with a custom theme that uses VERSION for various version strings (both in the .info.yml and .library.yml files). This constant should only be used for core themes, which something generated with this script by definition is not. 😅

Steps to reproduce

  1. Checkout 10.1.x core for local development.
  2. Run php core/scripts/drupal generate-theme foo --path themes/custom
  3. Inspect themes/custom/foo/foo.info.yml and themes/custom/foo/foo.libraries.yml.
  4. Find a bunch of references to VERSION.

Proposed resolution

generate-theme should create everything using 1.0.0-alpha1 as the version string, not core's VERSION constant.

Remaining tasks

  1. Do it.
  2. Tests?
  3. Reviews/refinements.
  4. RTBC.

User interface changes

None.

API changes

None.

Data model changes

None.

Release notes snippet

TBD. Probably not?

🐛 Bug report
Status

Active

Version

9.5

Component
Starterkit  →

Last updated 15 days ago

No maintainer
Created by

🇺🇸United States dww

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @dww
  • Comment 15 days ago →
    🇬🇷Greece akz

    Or perhaps `version` should be completely omitted and added by front end devs if desired and applicable in their dev workflows. In case `version: VERSION` is forgotten and left as is, it can be proven problematic because of this:

    Starting from Drupal 10.1.2, the version information within a library definition plays a critical role in generating a unique hash for aggregated files. Consequently, it is imperative that the "version" in a library definition is updated whenever a referenced CSS/JS file undergoes changes.

    Alternatively, if the version is omitted, the prior behavior will apply, where the content of referenced CSS/JS files is utilized in the hash.

    Incorrect usage of version information could lead to browser and edge cache invalidation issues.

    via https://www.drupal.org/docs/develop/creating-modules/adding-assets-css-j... →

    tldr; `version: VERSION` will not update the aggregated files every time their contents are updated.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024