Continuous Integration (CI)

Frontastic offers Continuous Integration (CI) as standard which can be extended to some degree. As our CI is only basic, we really recommend using your own CI service if you want to add more sophisticated build steps. See Extending the build system or the End2End testing with Frontastic articles for more information on how to do this.

The standard process involves the below steps:

  1. Trigger
    When you push a number of changes to the master branch of your project in GitHub, this will trigger a build in the format Y.m.d.H.i.

📘

Only 1 build can be run at a time. If 2 different developers commit around the same time, 1 build will run first then the 2nd will begin once the 1st build has finished. The 2nd build will run on the most recent state of the master branch, not for every push individually.

You can follow the progress of your build within the Frontastic studioFrontastic studio - The interface you use to manage, build, and edit all areas of your project and commerce sites. Previously known as `backstage`. (click Developer, then Continuous Integration).

📘

If you see a build number and it ends with -test, this isn't a full build and is only executed for test validation. It's not possible to deploy this version.

  1. Testing
    The testing of the build will then take place. We automatically run yarn run test and yarn run check for JavaScript (you can find these tests in your package.json), and phpunit for the PHP code (you can find this in phpunit.xml and the standard is test/php/)

  2. Building
    The JavaScript and CSS assets are then compiled. The new asset version is also linked from the default-template. All of this is then committed all together into master as the new build commit.

  3. Announcing
    Once the build has finished successfully, the results will be available in the Frontastic studioFrontastic studio - The interface you use to manage, build, and edit all areas of your project and commerce sites. Previously known as `backstage`. and the status in GitHub will also be updated. You'll also get the build result from either your Slack channel or MS Teams channel.

  4. Staging deployment
    If all of this is successful, your new build will then be deployed to your staging environment and new Google Cloud instances will be brought up there.

From start to finish, this process can take anywhere between a few minutes to 20 minutes. But it really depends on how much code you have in your repository and the additional tests you've added.

Commands

You can use your commit message to trigger some actions. Please note that the CI server only checks that last commit message, so if you push multiple commits at once, make sure the string is in the last commit message.

Embed the below string in your commit message:

  • #package or #build – Triggers an ant package in a branch other than the master branch. This can be used to then deploy a branch instead of the master branch.
  • #clear – Clears all node_modules folders. Since Yarn regularly fails to update all dependencies we offer you this to make it possible to trigger a fresh dependency installation on the CI server manually.

What next?

You'll then need to test your new build in the staging environment yourself and once you're ready, you can use the Frontastic studio to deploy to production.


Read next
Did this page help you?