feat!: rename directories, "-" → "_" (for django 3)

[wesleyboar]

Status

These are each being tested during migration to https://github.com/TACC/Core-CMS-Custom.

• fix(demdata-cms): rename, update, fix Core-CMS-Custom#164
• feat: a2cps_cms Core-CMS-Custom#175
• feat: tapisproject_cms Core-CMS-Custom#176
• feat: ecep_cms Core-CMS-Custom#184
• ... (taoteg or wesleyboar)

I warn in README to not deploy sites via this repo using Core-CMS v3.12, and instead migrate.

Overview / Changes

Rename …-cms|org to …_cms|org.

Related

• WP-114
• required by Update Django to v3.2 Core-CMS#625
• required by Update to Django 3.2 (for TUP CMS) Core-CMS#626
• required by feat(dev/tup-cms): django3, blog/news styles + related patterns Core-CMS#581

Testing & UI

See TACC/Core-CMS#626.

Notes

Without this PR, TACC/Core-CMS#625 build fails with:

[...] django.core.exceptions.ImproperlyConfigured: The app label 'example-cms' is not a valid Python identifier.

This update will break all Jenkins builds until edited. Also, I'd like to test these changes before merge. But I am willing to just bite the bullet and merge, then test each as they need to be re-deployed or as we have time. Fixes can always go into sites as they need them, and blame this PR as the origin of the problem.

[wesleyboar]

Filenames do not matter.

The directories that matter are apps, and directories named identical to apps, like …/texascale_org and …/texascale_org/static/texascale_org

[taoteg]

All good except LCCF, where the subdir still has its hyphen in two files (see comments).
Not sure if the settings_custom need to be updated as well.
Otherwise, all good!
Approving.

[wesleyboar]

Thanks, @taoteg.

I updated all the settings_custom.py a while back, but your comment prompted me to check again. I found some recent newcomers (from a merge of main) that I missed. I got 'em now.

I think what is next to do is test them all.

[taoteg]

Nice catch on brainmap!

[wesleyboar]

Some CMS projects rely on templates/ specifically within the …-cms/ directory, so a rename alone will not be adequate.

• To keep …-cms directories (even as symlinks) will ensure deploy fails with:
  The app label '…-cms' is not a valid Python identifier.
• To remove …-cms directories will ensure CMS's pages have 500 Internal Server Error upon deploy.

I investigate alternatives.

[wesleyboar]

Solutions

For any solution:

1. ✓ rename all the project dirs
2. → update CMS_TEMPLATES:
   • add new dir templates with same name as old dir templates
   • flag old dir templates as "DEPRECATED …"

Then continue with any chosen solution.

👎 A. Edit Pages to Use New Templates

3. → create symlinks from old dirs to new dirs only for affected projects¹
4. → soon, deploy to affected projects¹
5. → soon, change the template of all affected pages²
6. → soon, remove symlinks
7. → soon, deploy to affected projects¹

Untested.

✅ B. Add "Redirect" Templates

3. → create old dirs only for affected projects¹
4. → in old dirs, add missing templates that only extend the new templates
5. → whenever, deploy to affected projects¹
6. → whenever, change the template of all affected pages²

Tested on DemData.

Footnotes

1. Projects with affected pages² ↩ ↩² ↩³ ↩⁴ ↩⁵

2. Pages that load CMS_TEMPLATES from …-cms/templates ↩ ↩² ↩³

[wesleyboar]

[I moved this status update to the PR description.]

[wesleyboar]

I merged this so that CMS v3.12 can be released. All un-migrated sites (except TAPIS) are deployed with CMS v3.11. To avoid the problem and encourage migration, sites must not be deployed with CMS v3.12 unless migrated. I have stated such in the README.