Enhance/846b tb cleanup phase1dot5

.editorconfig

@@ -13,3 +13,7 @@ trim_trailing_whitespace = true
 
 [Makefile]
 indent_style = tab
+
+[*.yaml]
+indent_style = space
+indent_size = 2

dodo.py

@@ -16,10 +16,10 @@
 from project.gatsby import Gatsby
 from project.hugo import Hugo
 from project.laravel import Laravel
-from project.magento import Magento2ce
+# from project.magento import Magento2ce
 from project.pimcore import Pimcore
 from project.laravel import Laravel
-from project.magento import Magento2ce
+# from project.magento import Magento2ce
 from project.mattermost import Mattermost
 from project.mautic import Mautic
 from project.nextjs import Nextjs

project/ReadmeMixin.py

@@ -0,0 +1,28 @@
+class ReadmeMixin:
+    readMeFileName = "README"
+    readMeFileExt = "md"
+    readMeUpstreamFile = "_UPSTREAM"
+    readMePSHFile = "_PSH"
+
+    def rename_psh_readme(self):
+        return 'cd {0} && if [[ -f "{1}.{2}" ]]; then echo "Moving {1}.{2} to {1}{3}.{2}"; mv "{1}.{2}" "{1}{3}.{2}";' \
+               'fi;'.format(self.builddir, self.readMeFileName, self.readMeFileExt, self.readMePSHFile)
+
+    def rename_psh_readme_back(self):
+        return 'cd {0} && if [[ -f "{1}{3}.{2}" ]]; then echo "Moving our {1}{3}.{2} back to {1}.{2}";mv "{1}{3}.{2}" '\
+               '"{1}.{2}";fi;'.format(self.builddir,self.readMeFileName,self.readMeFileExt,self.readMePSHFile)
+
+        # return 'cd {0} && if [[ -f "{1}{3}.{2}" ]]; then echo "Moving our {1}{3}.{2} back to {1}.{2}";mv "{1}{3}.{2}" '\
+        #        '"{1}.{2}";git add {1}.{2};git commit -m "Committing our {1}.{2}";fi;'.format(self.builddir,
+        #                                                                                      self.readMeFileName,
+        #                                                                                      self.readMeFileExt,
+        #                                                                                      self.readMePSHFile)
+
+    def rename_upstream_readme(self):
+        return 'cd {0} && if [[ -f "{1}.{2}" ]]; then echo "moving upstream {1}.{2} to {1}{3}.{2}";mv "{1}.{2}" "{1}{' \
+               '3}.{2}";fi;'.format(self.builddir,self.readMeFileName,self.readMeFileExt,self.readMeUpstreamFile)
+        # return 'cd {0} && if [[ -f "{1}.{2}" ]]; then echo "moving upstream {1}.{2} to {1}{3}.{2}";mv "{1}.{2}" "{1}{' \
+        #        '3}.{2}"; git add "{1}{3}.{2}";git commit -m "renamed {1} to {1}{3}";fi;'.format(self.builddir,
+        #                                                                                         self.readMeFileName,
+        #                                                                                         self.readMeFileExt,
+        #                                                                                         self.readMeUpstreamFile)

project/__init__.py

@@ -114,7 +114,7 @@ def init(self):
             name = self.github_name
         else:
             name = self.name.replace('_', '-')
-        return ['git clone [email protected]:{2}/{0}.git {1}'.format(
+        return ['git clone --progress --verbose [email protected]:{2}/{0}.git {1}'.format(
             name, self.builddir, self.template_org)
         ]
 

project/drupal.py

@@ -166,6 +166,10 @@ def update(self):
             'cd {0} && composer remove php {1}'.format(self.builddir,
                                                        self.composer_defaults().replace('--prefer-dist', '')),
             # 'cd {0} && rm -rf web/profiles/govcms'.format(self.builddir),
+            # for some reason, lcobucci/clock decided to bump the min php version to 8.2 between version 3.0.0 and 3.1.0
+            # https://github.com/lcobucci/clock/releases/tag/3.1.0
+            # @todo for now locking to 3.0.0 until we upgrade this project to php 8.2
+            'cd {0} && composer require lcobucci/clock:3.0.0 {1}'.format(self.builddir, self.composer_defaults()),
         ]
 
     @property

project/magento.py → project/magento-archived.py

@@ -119,13 +119,13 @@ def magento_modify_composer(composer):
             (self.modify_composer, [magento_modify_composer])
         ]
 
-    @property
-    def platformify(self):
-        extraIgnores = '--ignore-platform-req=ext-iconv --ignore-platform-req=ext-soap ' \
-                       '--ignore-platform-req=ext-pdo_mysql '
-
-        return super(Magento2ce, self).platformify + [
-                'cd {0} && composer require magento/ece-tools magento/magento-cloud-components '
-                'magento/quality-patches -W '.format(self.builddir)  + self.composer_defaults() + extraIgnores,
-                'cd {0} && composer update -W {1}'.format(self.builddir, self.composer_defaults() + extraIgnores),
-                ]
+    # @property
+    # def platformify(self):
+    #     extraIgnores = '--ignore-platform-req=ext-iconv --ignore-platform-req=ext-soap ' \
+    #                    '--ignore-platform-req=ext-pdo_mysql '
+    #
+    #     return super(Magento2ce, self).platformify + [
+    #             'cd {0} && composer require magento/ece-tools magento/magento-cloud-components '
+    #             'magento/quality-patches -W '.format(self.builddir)  + self.composer_defaults() + extraIgnores,
+    #             'cd {0} && composer update -W {1}'.format(self.builddir, self.composer_defaults() + extraIgnores),
+    #             ]

project/nuxtjs.py

@@ -1,17 +1,17 @@
 from . import BaseProject
+from project.ReadmeMixin import ReadmeMixin
 import json
 import os
 
-class Nuxtjs(BaseProject):
 
+class Nuxtjs(BaseProject, ReadmeMixin):
     # Keeps package-lock.json out of repo. See notes.md (Yarn - Overwriting updateCommands) for more details.
     updateCommands = {
         'package.json': 'yarn upgrade'
     }
 
     @property
     def update(self):
-
         ROOTDIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
         TEMPLATEDIR = os.path.join(ROOTDIR, 'templates/nuxtjs')
 
@@ -25,6 +25,7 @@ def update(self):
             "language": "js",
             "pm": "yarn",
             "ui": "none",
+            "template": "html",
             "features": [],
             "linter": [],
             "test": "none",
@@ -39,22 +40,38 @@ def set_default(obj):
                 return list(obj)
             raise TypeError
 
-        return [
+        actions = [
+            #just in case a previous update failed, our temp directory may still be around
+            'cd {0} && if [ -d "{1}" ]; then echo "removing previous {1} directory...";rm -rf {1};fi;'.format(TEMPLATEDIR,projectName),
+            super(Nuxtjs, self).rename_psh_readme(),
             # Create a NuxtJS app using Yarn, since there's no dedicated upstream repo for it. Yarn prevents you
             # from creating a new project in a nonempty dir, so the project is made in projectName before its
             # contents are copied into builddir.
-            'cd {0} && npx create-nuxt-app --answers \"{1}\" {2}'.format(TEMPLATEDIR, json.dumps(createNuxtAppAnswers, default=set_default).replace('"', '\\"'), projectName),
+            # 'cd {0} && npx create-nuxt-app --answers \"{1}\" {2}'.format(TEMPLATEDIR,
+            #                                                              json.dumps(createNuxtAppAnswers,
+            #                                                                         default=set_default).replace(
+            #                                                                  '"', '\\"'), projectName),
+            'cd {0} && npx nuxi@latest init {1}'.format(TEMPLATEDIR,projectName),
             # Disable telemtery so we are not asked for it when running the application the first time
-            'cd {0}/{1} && npx nuxt telemetry disable'.format(TEMPLATEDIR, projectName),
+            #'cd {0}/{1} && npx nuxt telemetry disable'.format(TEMPLATEDIR, projectName),
             'cd {0} && rm -rf {1}/.git'.format(TEMPLATEDIR, projectName),
             'cd {0} && cp -r {1}/{2}/* .'.format(self.builddir, TEMPLATEDIR, projectName),
             'cd {0} && rm -rf {1}'.format(TEMPLATEDIR, projectName),
-        ] + super(Nuxtjs, self).update
+            'echo "Going to delete the old readme_upstream..."',
+            'cd {0} && if [ -f "README_upstream.md" ]; then echo "deleting previous README_upstream"; rm README_upstream.md;fi;'.format(
+                self.builddir),
+            'echo "Going to rename the new README to README_UPSTREAM"',
+            super(Nuxtjs, self).rename_upstream_readme(),
+            super(Nuxtjs, self).rename_psh_readme_back(),
+        ]
+
+        actions.extend(self.package_update_actions())
+
+        return actions
 
     @property
     def platformify(self):
-
         return super(Nuxtjs, self).platformify + [
             # Add dependencies.
             'cd {0} && yarn add platformsh-config'.format(self.builddir),
-        ]
+        ]

project/remote.py

@@ -1,11 +1,10 @@
 import subprocess
-
 import packaging.version
-
 from . import BaseProject
+from project.ReadmeMixin import ReadmeMixin
 
 
-class RemoteProject(BaseProject):
+class RemoteProject(BaseProject, ReadmeMixin):
     """
     Base class for projects that need to synchronize code with an upstream source.
 
@@ -21,11 +20,6 @@ class RemoteProject(BaseProject):
         from which to pull. (If both are defined, `major_version` take precedence.)
     """
 
-    readMeFileName = "README"
-    readMeFileExt = "md"
-    readMeUpstreamFile = "_UPSTREAM"
-    readMePSHFile = "_PSH"
-
     @property
     def init(self):
         return super(RemoteProject, self).init + [
@@ -37,13 +31,14 @@ def init(self):
     def update(self):
         actions = [
             # If we have a readme file from the template repository, rename it so we can bring it back later
-            'cd {0} && if [[ -f "{1}.{2}" ]]; then echo "Moving {1}.{2} to {1}{3}.{2}"; mv "{1}.{2}" "{1}{3}.{2}"; fi;'
-            .format(self.builddir, self.readMeFileName, self.readMeFileExt, self.readMePSHFile),
+            # 'cd {0} && if [[ -f "{1}.{2}" ]]; then echo "Moving {1}.{2} to {1}{3}.{2}"; mv "{1}.{2}" "{1}{3}.{2}"; fi;'
+            # .format(self.builddir, self.readMeFileName, self.readMeFileExt, self.readMePSHFile),
+            super(RemoteProject, self).rename_psh_readme(),
             'cd {0} && git checkout {1}'.format(self.builddir, self.default_branch),
             'cd {0} && git fetch --all --depth=2'.format(self.builddir),
             'cd {0} && git fetch --all --tags'.format(self.builddir),
             # now we need to handle our .github directory and files
-            'cd {0} && [ -d {1} ] && mv {1} {2}'.format(self.builddir,'.github','tmp.github')
+            'cd {0} &&  if [ -d {1} ]; then mv {1} {2};fi;'.format(self.builddir, '.github', 'tmp.github')
             # Remove working directory files when updating from upstream, so that deletions get picked up.
             # Disabled, because it was breaking Magento updates. Even though it was added to avoid breaking Magento updates.
             # 'cd {0} &&  (find . -maxdepth 1 -not \( -path ./.git -o -path . \) -exec rm -rf {{}} \;)'.format(self.builddir),
@@ -68,24 +63,27 @@ def merge_from_upstream_tag():
 
         # now we need to deal with the upstream README
         actions.append(
-            'cd {0} && if [[ -f "{1}.{2}" ]]; then echo "moving upstream {1}.{2} to {1}{3}.{2}";mv "{1}.{2}" "{1}'
-            '{3}.{2}"; git add "{1}{3}.{2}";git commit -m "renamed {1} to {1}{3}";fi;'
-            .format(self.builddir, self.readMeFileName, self.readMeFileExt, self.readMeUpstreamFile)
+            super(RemoteProject, self).rename_upstream_readme()
+            # 'cd {0} && if [[ -f "{1}.{2}" ]]; then echo "moving upstream {1}.{2} to {1}{3}.{2}";mv "{1}.{2}" "{1}'
+            # '{3}.{2}"; git add "{1}{3}.{2}";git commit -m "renamed {1} to {1}{3}";fi;'
+            # .format(self.builddir, self.readMeFileName, self.readMeFileExt, self.readMeUpstreamFile)
         )
 
         # and now our README
         actions.append(
-            'cd {0} && if [[ -f "{1}{3}.{2}" ]]; then echo "Moving our {1}{3}.{2} back to {1}.{2}";mv "{1}{3}.{2}" "'
-            '{1}.{2}";git add {1}.{2};git commit -m "Commiting our {1}.{2}";fi;'
-            .format(self.builddir, self.readMeFileName, self.readMeFileExt, self.readMePSHFile)
+            super(RemoteProject, self).rename_psh_readme_back()
+            # 'cd {0} && if [[ -f "{1}{3}.{2}" ]]; then echo "Moving our {1}{3}.{2} back to {1}.{2}";mv "{1}{3}.{2}" "'
+            # '{1}.{2}";git add {1}.{2};git commit -m "Commiting our {1}.{2}";fi;'
+            # .format(self.builddir, self.readMeFileName, self.readMeFileExt, self.readMePSHFile)
         )
 
         # now if a .github directory was reintroduced from the upstream, delete it, and then if ours is present, rename
         # it back to .github
         actions.append(
             # remove a .github directory that might have been brought in from upstream
             # @todo should we loop through all possible directories/files that may need to be removed?
-            'cd {0}; if [ -d {1} ]; then rm -rf {1};fi; if [ -d {2} ]; then mv {2} {1};fi;'.format(self.builddir, '.github', 'tmp'
+            'cd {0}; if [ -d {1} ]; then rm -rf {1};fi; if [ -d {2} ]; then mv {2} {1};fi;'.format(self.builddir,
+                                                                                                   '.github', 'tmp'
                                                                                                               '.github')
         )
         # Do this last so it picks up all changes from above.

project/wordpress.py

@@ -20,7 +20,9 @@ def platformify(self):
             # Release the tar and cleanup.
             'cd {0} && tar -xvf {1}.tar.gz && rm {1}.tar.gz'.format(self.builddir, self.install_dir),
             # Move Platform.sh files into `wordpress`.
-            'cd {0} && mv wp-config.php {1} && mv wp-cli.yml {1}'.format(self.builddir, self.install_dir),
+            # No longer needed as our wp-config and wp-cli.yml files are already in the wordpress directory from the
+            # template repository
+            # 'cd {0} && mv wp-config.php {1} && mv wp-cli.yml {1}'.format(self.builddir, self.install_dir),
         ]
 
 

templates/beego/files/.platform.app.yaml

@@ -1,47 +1,77 @@
-# This file describes an application. You can have multiple applications
-# in the same project.
-#
-# See https://docs.platform.sh/user_guide/reference/platform-app-yaml.html
+# Complete list of all available properties: https://docs.platform.sh/create-apps/app-reference.html
 
-# The name of this app. Must be unique within a project.
+# A unique name for the app. Must be lowercase alphanumeric characters. Changing the name destroys data associated
+# with the app.
 name: app
 
 # The runtime the application uses.
+# Complete list of available runtimes: https://docs.platform.sh/create-apps/app-reference.html#types
 type: golang:1.16
 
-# The hooks executed at various points in the lifecycle of the application.
-hooks:
-    build: |
-        # Modify this line if you want to build differently or use an alternate name for your executable.
-        go build -o bin/app
-
+# The relationships of the application with services or other applications.
+# The left-hand side is the name of the relationship as it will be exposed
+# to the application in the PLATFORM_RELATIONSHIPS variable. The right-hand
+# side is in the form `<service name>:<endpoint name>`.
+# More information: https://docs.platform.sh/create-apps/app-reference.html#relationships
 relationships:
-    database: "db:mysql"
+  database: "db:mysql"
 
-# The configuration of app when it is exposed to the web.
-web:
-    upstream:
-        socket_family: tcp
-        protocol: http
-
-    commands:
-        # If you change the build output in the build hook above, update this line as well.
-        start: ./bin/app
-
-    locations:
-        /:
-            # Route all requests to the Go app, unconditionally.
-            # If you want some files served directly by the web server without hitting Go, see
-            # https://docs.platform.sh/configuration/app/web.html
-            allow: false
-            passthru: true
-
-# The size of the persistent disk of the application (in MB).
+# The size of the persistent disk of the application (in MB). Minimum value is 128.
 disk: 1024
 
+# The web key configures the web server running in front of your app.
+# More information: https://docs.platform.sh/create-apps/app-reference.html#web
+web:
+  # More information: https://docs.platform.sh/configuration/app-containers.html#upstream
+  upstream:
+    # Whether your app should speak to the webserver via TCP or Unix socket. Defaults to tcp
+    # More information: https://docs.platform.sh/create-apps/app-reference.html#where-to-listen
+    socket_family: tcp
+    protocol: http
+
+  # Commands are run once after deployment to start the application process.
+  # More information: https://docs.platform.sh/create-apps/app-reference.html#web-commands
+  commands:
+    # The command to launch your app. If it terminates, it’s restarted immediately.
+    # If you change the build output in the build hook update this line as well.
+    start: ./bin/app
+
+  # Each key in locations is a path on your site with a leading /.
+  # More information: https://docs.platform.sh/create-apps/app-reference.html#locations
+  locations:
+    /:
+      # Whether to allow serving files which don’t match a rule.
+      # Route all requests to the Go app, unconditionally.
+      # If you want some files served directly by the web server without hitting Go, see
+      # https://docs.platform.sh/configuration/app/web.html
+      allow: false
+      # Whether to forward disallowed and missing resources from this location to the app. A string is a path
+      # with a leading / to the controller, such as /index.php.
+      passthru: true
+
+# Hooks allow you to customize your code/environment as the project moves through the build and deploy stages
+# More information: https://docs.platform.sh/create-apps/app-reference.html#hooks
+hooks:
+  # The build hook is run after any build flavor.
+  # More information: https://docs.platform.sh/create-apps/hooks/hooks-comparison.html#build-hook
+  build: |
+    # Modify this line if you want to build differently or use an alternate name for your executable.
+    go build -o bin/app
+
+# Information on the app's source code and operations that can be run on it.
+# More information: https://docs.platform.sh/create-apps/app-reference.html#source
 source:
+  ######################################################################################################################
+  ##                                                                                                                  ##
+  ## This source operation is part of the Platform.sh process of updating and maintaining our collection of           ##
+  ## templates. For more information see https://docs.platform.sh/create-apps/source-operations.html and              ##
+  ## https://github.com/platformsh/source-operations                                                                  ##
+  ##                                                                                                                  ##
+  ##                  YOU CAN SAFELY DELETE THIS COMMENT AND THE LINES BENEATH IT                                     ##
+  ##                                                                                                                  ##
+  ######################################################################################################################
   operations:
     auto-update:
       command: |
         curl -fsS https://raw.githubusercontent.com/platformsh/source-operations/main/setup.sh | { bash /dev/fd/3 sop-autoupdate; } 3<&0
-    
+

templates/beego/files/.platform/routes.yaml

@@ -1,13 +1,14 @@
-
 # The routes of the project.
 #
 # Each route describes how an incoming URL is going
 # to be processed by Platform.sh.
-
+# More information: https://docs.platform.sh/define-routes.html
 "https://{default}/":
-    type: upstream
-    upstream: "app:http"
+  type: upstream
+  upstream: "app:http"
 
+# A basic redirect definition
+# More information: https://docs.platform.sh/define-routes.html#basic-redirect-definition
 "https://www.{default}/":
-    type: redirect
-    to: "https://{default}/"
+  type: redirect
+  to: "https://{default}/"