silverstripe-module build

silverstripe-australia/build

Phing build helpers for projects making use of the silverstripe-base installation process.

Requirments

• Phing
• php cli
• PEAR (with a version of phpunit supported by silverstripe)

Installation

• Edit scripts/build.xml and change the name attribute to
• Copy scripts/build.properties.sample to scripts/build.properties
• Edit build.properties and change the DB configuration and rewrite.base settings.
• Run phing -f scripts/build.xml to make sure everything installs
• If you require additional modules, add them into the scripts/dependent-modules file, then run phing -f scripts/build.xml update_modules
• Run phing -f scripts/build.xml test to make sure everything's working as expected

Phing targets

Commonly used targets, _(*1)

• build
• test
• package

Helpful for development:, _(*2)

• pak - builds a .sspak file at mysite/build/site.sspak . Useful for CI
• phpstan - Runs PHPStan + PHPStan for SilverStripe if it's installed via Composer. Useful for static analysis of PHP code.
  • Define folders to scan by placing following in your build.xml file, underneath the <project> tag.
    • <property name="phpstan.dir" value="mysite/src mysite/tests" />

Composer scripts

If your themes use yarn based dependencies, you can add the following post-install scripts to be triggered by a composer call, which will ensure the node_modules are installed correctly, _(*3)

    "scripts": {
        "post-update-cmd": [        
                "Symbiote\\Build\\ThemeBuilder::run"
        ],
        "post-install-cmd": [
                "Symbiote\\Build\\ThemeBuilder::run"
        ]
    },

Optional Scripts

There are three scripts that may optionally be used for your projects, and can be done using the following commands., _(*4)

sh build/scripts/cache

This will clear out any project cache files (for all projects), and is basically the forced equivalent of doing a ?flush for everything in your site., _(*5)

sh ~/path/to/permissions

This requires you to update the "{user}" and as such will need to be copied out to a location of your choice, and will apply the appropriate owner and permissions to both the cache and repository., _(*6)

sh build/scripts/recursive-status

This will recursively trigger a "git status" on each module directory found within your repository, primarily so you check for changes that may have been made in a module that hasn't been included in the repository code base., _(*7)

sh build/scripts/recursive-status assume-unchanged-listing

When you have patched files (resulting in them coming up as being modified during a recursive-status), you can git update-index --assume-unchanged {file_name}, and use this script with a parameter. This will not only list out the files that have been assumed unchanged, but it will also force the files to reflect the upstream. This makes sure you don't have local changes that have been accidentally made, however it will also remove any patches that were put in place. Therefore, you can run this and then phing to ensure the patches remain in place., _(*8)

Excluding files from packages

Create a {root}/.pkgignore file with a set of paths to be excluded from built up package files, _(*9)

vendor/un-used/module/
themes/mytheme/node_modules/
mysite/cypress/