uni-elentra-1x-me
) repository.
consortium
Git remote that points to the Consortium Edition elentra-1x-me
repository, then ensure that you add one:git fetch consortium
.
uni/staging
) and create a new branch based on this branch (e.g., uni/staging-v118
) just for easy restore purposes in case it's needed. Once that branch has been created, checkout the original Branded Edition staging branch (e.g., uni/staging
) and continue.
consortium
remote, then right click on release/1.19
and click Pull consortium/release/1.19 into uni/staging
.
At this point, you may be asked to resolve any merge conflicts that have been created by making modifications to your Branded Edition that conflict with changes that have been made to the Consortium Edition. Depending on your level of conflict, this could be as simple as a minor modification to the composer.lock
file or something much more complex. If you require assistance, please book an appointment with the Elentra Consortium Core Team, or chat with us on Slack in the #developers channel and we will provide you with guidance or assistance on moving forward.
Generally speaking, we always recommend that Consortium Participants follow the Contribution best practices defined in our documentation, which may help reduce the number of conflicts that you encounter.
uni/staging
branch and continue to Part 2 of the instructions.origin
remote at this point. Wait until Part 2 has been completed and you have finished some initial local testing.master
branch of your Branded Edition Elentra API to your local environment using Sourcetree.
git fetch consortium
.
consortium
remote, then right click on master
and click Pull consortium/master into uni/master
. There may be merge conflicts that must be resolved if customizations made to your Branded Edition Elentra API.
master
branch of your Branded Edition Elentra API. Push these changes to your origin
remote.
v4.1.3
and the composer.json
provided with Elentra ME 1.19 specifies that the major version of API version must be ~4.0
. Create a new tag where the current date follows the patch version: 4.1.3.20200827
.
More information about tagging API releases can be found here.
deploy.php
) that you set theenabled_branded_api
option to true
and the deployment script will take care of the rest during deployment.www-root/core/config/settings.inc.php
with each environmental settings file in the www-root/core/config
directory (e.g., settings-staging.inc.php
, settings-production.inc.php
).
When you compare the Consortium Edition settings.inc.php
file with your Branded Edition files, you are looking to add additional settings that have been added to the stock settings.inc.php
file and remove any settings that have been removed from the stock settings.inc.php
file. In most cases, your Branded Edition settings files should have the same lines (albeit potentially different settings values) as the Consortium Edition.
Once you have compared your settings files, commit the changes to your uni/staging
branch.
www-root/templates/default
directory with each Branded Edition customized template in the www-root/templates
directory (e.g., www-root/templates/uni
).
In most cases, you will want to add missing files, update your language files, examine each modification to the CSS files, and add any modifications to your header.tpl.php
files.
This process can take some time depending on the level of change in your implementation, and should be repeated for each template you have created.
Once you have compared your templates, commit the changes to your uni/staging
branch.elentra-developer
Docker container, and change to your uni-elentra-1x-me
directory:origin
remote.deploy.rb
and Deployer's deploy.php
) you will see the same/similar variables, structure, and patterns..deployignore
and deploy.php
files from the Elentra Developer GitHub Repository and place them in your ~/Sites/uni-elentra-1x-me/deployment
directory alongside the existing Capistrano Capfile
and config/deploy.rb
files in the uni/staging
branch.deployment/config/deploy.rb
and the Deployer ("Dep") deployment/deploy.php
deployment recipes in your editor or IDE. There are a few variables at the top of deploy.php
that need to be set. The following table describes variable names that must set.uni-elentra-1x-me
)master
) within your Branded Edition Elentra ME Git repository. This value is always overridden by the host configuration section (if present), so it not overly important.cap staging deploy
dep deploy staging
cap production deploy
dep deploy production
cap staging deploy:rollback
dep rollback staging
uni/staging
branch to your origin
remote, you can now deploy the upgrade to your staging environment from within your Docker container.elentra-developer
Docker container, and change to your deployment
directory:scrub.sh
shell script included with the Elentra Platform.uni-elentra-1x-me
) repository.
uni/production
branch.
uni/staging
branch and click "Merge uni/staging into uni/production". This will merge all of the commits that have gone into creating the upgrade, into your uni/production
branch.
uni/production
branch to your origin
remote. Log into your local elentra-developer
Docker container, and change to your deployment
directory:app.json
file. If you pull from the release branch, or if you're upgrading for the first time, please run these commands on your servers.