migration.ini [RepositorySettings] #

The block [RepositorySettings] of settings/migration.ini, with 8 setting(s).

Never edit settings/migration.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/migration.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/migration.ini.append.php for one siteaccess,
• extension/<extension>/settings/migration.ini.append.php in an extension (read when the extension is active).

Mode #

Where the record of the runs is kept under version control: the status files (status/<environment>.json) and the
run logs (runs/<run-id>.log).
site Path is a folder of the installation's own git repository
separate Path is a git repository of its own

Default: site.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
Mode=site
*/ ?>

Path #

The folder, relative to the installation's root or absolute.

Default: migrations.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
Path=migrations
*/ ?>

Remote #

The remote a run pushes to (any git remote: GitHub, GitLab, a server of your own). Empty: no push.

Default: origin.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
Remote=origin
*/ ?>

Branch #

The branch a run commits on. Empty: the branch the repository is on. A repository on another branch is not
committed to (a warning says so).

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
Branch=
*/ ?>

Commit #

enabled: the status file and the run log are committed after every run, the failed ones too.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
Commit=enabled
*/ ?>

Tag #

enabled: the commit is tagged (one run, one revision: commit and tag). A tag is never moved or replaced.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
Tag=enabled
*/ ?>

TagPattern #

The name of the tag: <environment> (default when the installation names none), <run-id>, <date> (YYYYMMDD).

Default: migrations/<environment>/<run-id>.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
TagPattern=migrations/<environment>/<run-id>
*/ ?>

Push #

enabled: the commit and its tag are pushed to Remote. A push that fails stays local and is tried again by the
cronjob part migrationpush (php runcronjobs.php migrationpush).

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RepositorySettings]
Push=enabled
*/ ?>

Related #

• All blocks of migration.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/migration.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.