Orchid comes with a simple, yet flexible and powerful mechanism for deploying your site once it has been built. Rather
than struggling to set up shell scripts to deploy your site, let Orchid do the hard for you. Your site is simple and
beautiful, letting others see it should be just the same.
The typical approach to deployment with static sites is to have a CI server, like Travis CI or Netlify, build your site
and then do something with the result of the build. This works well enough if you only run Orchid from one place, but it
gets tricky if you end up changing CI providers or need to do a quick deploy from your local machine when the CI server
Every CI tool has their own custom method of deploying your site to AWS, Github Pages, etc. so you start to get locked
into that one provider. By moving the deployment process inside the lifecycle of an Orchid build process, you can
simplify the process and also prevent yourself from getting locked into any one CI tool.
In addition, Orchid knows much more about your site than the CI server does, and it can use that knowledge to reduce
the amound of configuration needed.
For production builds with Orchid that include a deployment step, run the
orchidDeploy gradle task instead of
orchidBuild. This will run the normal build as you'd expect, but follow that build with a deploy step after the build
completes successfully. You can also run a deploy manually by issuing the
command from an interactive session or through the admin panel.
Setting up a deployment pipeline is configured in your
config.yml under the
services.publications.stages key. It
follows the same modular configuration you've come to expect and love that is used for components, menus, and forms.
- type: script
- type: ghPages
Running the deployment pipeline is a 2-step process: validation, and execution.
Every step in the pipeline is first validated, to make sure that it is set up correctly. While this is not foolproof,
as it is left up to the developer to validate the build phase properly and fully, it can greatly help in reducing the
chance of a botched deployment.
During the validation phase, every publisher gets a chance to be validated. If any stage fails validation, the entire
pipeline will be aborted, and no stages will be executed. This allows you to perform sanity checks on the configuration
to make sure all required fields are accounted for, and even to do other checks such as verify network connectivity.
After all deployment stages have been validated, they will then be executed in the same order. If any pipeline stage
fails, the entire deployment is aborted. Stages can be given custom ordering, and you can make expectations that a
previous stage will be executed have have its outputs ready for later stages. This allows the pipeline to be used as a
full post-processing pipeline rather than just a deployment mechanism. One example is to optimize all assets, or to
compress and uglify the resulting assets, which would be difficult to apply across all pages with the existing indexing
and generating APIs.
You can have Orchid run a dry deploy, and it will validate all publication stages for you without executing them. This
allows you to quickly and safely ensure that you have your pipeline configured correctly at all stages before attempting
a full deploy.
deploy is run as an Orchid task (that is, with the
orchidDeploy gradle task, or
orchidRun -PorchidRunTask=deploy) the pipeline is not dry and is run as a full deploy.
deploy is run as a command, either from an xinteractive command-line session or submitted through the admin panel,
it is dry by default. You can issue a command for a full deploy with
deploy -- -dry false or (
deploy false for
In addition, you can make any single deployment stage run dry, even when the rest aren't, with an option on the stage's
config. Note that this does not override the flag on the entire process, so setting
dry to false on a dry run will
not force that stage to execute anyway.
- type: ghPages
There are several publishers available in
OrchidCore, but more may be available in plugins, or you may
create your own.
- Script - Execute arbitrary shell scripts
- Netlify - Upload your site to Netlify
- GitHub - Push your site to GitHub Pages or create releases
- Gitlab - Push your site to Gitlab Pages
- Bitbucket - Push your site to Gitlab Pages