Problem/Motivation

Scaffold files were added to drupal/core in Drupal 8.8.x. During the Drupal 8
development cycle, the scaffold files are also being maintained in their original
locations. This is done so that Drupal sites based on the template project
drupal-composer/drupal-project may continue to download these files from the same
URLs they have historically been found at.

The scaffold files will be deleted from their original location in Drupal 9.
See https://www.drupal.org/project/drupal/issues/3075954 for follow-on work.

1. It's not the Drupal 8 cycle any more.
2. We don't need to say when these were added any more; it's not relevant information.
3. #3075954: Remove duplicate scaffold files is still needs work, so I think saying the files will be removed in D9 is optimistic. Perhaps we should just say 'in a future version'?

Issue fork drupal-3247666

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

joachim created an issue. See original summary.

larowlan’s picture

Category: Bug report » Task
Issue tags: +Bug Smash Initiative

This feels like a task to me

vicheldt’s picture

Assigned: Unassigned » vicheldt

I'll change the documentation.

vicheldt’s picture

Assigned: vicheldt » Unassigned
Status: Active » Needs review
StatusFileSize
new978 bytes

I removed all the text informing the reason when scaffold files were added on Drupal. If this patch looks ok let me know so I can create a MR, if it doesn't let me know what I can change.

Status: Needs review » Needs work

The last submitted patch, 4: 3247666-scaffold-files.patch, failed testing. View results

longwave’s picture

The test failure is unrelated, but one nit:

+++ b/core/assets/scaffold/README.txt
@@ -1,11 +1,6 @@
+The scaffold files will be deleted from their original location in a future
+version of Drupal.
 See https://www.drupal.org/project/drupal/issues/3075954 for follow-on work.

This text can be wrapped into a single paragraph.

joachim’s picture

+++ b/core/assets/scaffold/README.txt
@@ -1,11 +1,6 @@
-locations. This is done so that Drupal sites based on the template project
-drupal-composer/drupal-project may continue to download these files from the same
-URLs they have historically been found at.

Is this bit still true -- does that template still need this?

vicheldt’s picture

@longwave if i put that all on a single paragraph, that'd be more than 80 characters on one line, isn't that against the coding standards?

vicheldt’s picture

@joachim i am not sure that this part is needed because the scaffold files will be removed from the original location, so that part won't be true anymore, that's why i deleted that part of the documentation, but if that's still true let me know and i'll put it back.

vicheldt’s picture

StatusFileSize
new954 bytes

I rephrased so that the text can be in one line that doesn't go over 80 characters.

vicheldt’s picture

Status: Needs work » Needs review
SomeIntern’s picture

Patch in #10 applied correctly to 9.3x, described changes to the documentation were made.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

dandeleon03’s picture

StatusFileSize
new232.56 KB

Hi @vicheldt, @SomeIntern,

Patch in #10 is checked and verified and is correctly updated.

Please see screenshot.

Thanks.

joachim’s picture

Status: Needs review » Needs work

We've lost this part:

, the scaffold files are also being maintained in their original
locations. This is done so that Drupal sites based on the template project
drupal-composer/drupal-project may continue to download these files from the same
URLs they have historically been found at.

which is still relevant.

@dandeleon03 thanks for the review, but please don't post screenshots of diffs. There's no point, and it just uses up storage space.

anagomes’s picture

Assigned: Unassigned » anagomes
anagomes’s picture

Assigned: anagomes » Unassigned
Status: Needs work » Needs review
StatusFileSize
new1.12 KB
new662 bytes

I added the part that @joachim mentioned in #15, I hope this is good enough.

dandeleon03’s picture

Status: Needs review » Reviewed & tested by the community

Hi @joachim

Apologies, since I am quite new to testing here. I'll bear it in mind next time.

@anagomes

Checked and confirmed that the one mentioned by @joachim in #15 is already added in your latest patch.

Thank you both.

alexpott’s picture

Version: 9.4.x-dev » 9.3.x-dev
Status: Reviewed & tested by the community » Fixed

Committed and pushed f59f3ae9fba to 10.0.x and 71bd9d45fb0 to 9.4.x and 1a7b5c23e05 to 9.3.x. Thanks!

Backported to 9.3.x since this a docs fix.

  • alexpott committed f59f3ae on 10.0.x
    Issue #3247666 by vicheldt, anagomes, joachim, longwave: scaffold README...

  • alexpott committed 71bd9d4 on 9.4.x
    Issue #3247666 by vicheldt, anagomes, joachim, longwave: scaffold README...

  • alexpott committed 1a7b5c2 on 9.3.x
    Issue #3247666 by vicheldt, anagomes, joachim, longwave: scaffold README...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.