Releases: drevops/vortex
9.x-1.15 New variables system, PHP 8.1, self-hosted RenovateBot, improved integrations.
π³ Docker
- Updated from PHP 7 to PHP 8.1 and optimised configuration files.
- Updated images to the
22.4.1
version. - Renamed Docker files to use
.dockerfile
extension (i.e.Dockerfile.php
->php.dockerfile
). - Added
auth.json
to a list of included files into Docker build. - Fixed forwarding emails to Mailhog locally.
π§ Drupal
- Upgraded to Drush 11.
- Added unit tests for settings: testing the resulting settings based on environment type and set environment variables.
- Added support for settings to be included from the
includes
directory (ueful to store contrib module settings). - Added
installer-path
support for custom modules and themes incomposer.json
. - Fixed site salt value in settings.
- Updated Shield settings to allow enabling from UI.
- Updated theme scaffold to use Olivero as a base theme.
- Updated theme
npm run watch
to run dev compilation. - Updated theme NPM packages to the latest versions.
- Moved Livereload inclusion into theme.
- Switched from non-supported
node-sass
tosass
((Dart SASS)[https://sass-lang.com/dart-sass]) in theme
π€ CI and workflow
New features
- New varibles system to clearly separate between DrevOps, Drupal and 3rd-party variables:
- DrevOps variables use
DREVOPS_
prefix. - Drupal variables use
DRUPAL_
prefix. - 3-rd party services variables stay as-is.
- DrevOps variables use
- New site install logic and logging to prevent accidental environment overwrites and deletions.
- New Drupal deployment mechanism using
drush deploy
. - New RenovateBot config (including self-hosted CI config) and removed dependencies.io.
- New deployment scripts for GitHub, NewRelic and JIRA notifications.
- New local Ahoy commands: commands can be added into
.ahoy.local.yml
which is automatically included int main Ahoy configuration and is excluded to be committed to the codebase. - New script to mirror code between branches.
- New script to create GitHub labels. Used to configure repositories.
- New GitHub action to auto-assign PR author.
Updates
- Refactored scripts to use better logging output.
- Added Drupal login and logout scripts.
- Allow to skip unit, functional and kernel tests tagged with skipped group by providing envir9onment variables.
- Added skipping of site installation with
DREVOPS_DRUPAL_INSTALL_SKIP
. - Removed
DREVOPS_DRUPAL_CONFIG_LABEL
as Drush 11 does not support it anymore. - Added validation of the docker compose configuration.
- Moved network creation to run after composer validation.
- Added variables to skip linting (
DREVOPS_LINT_SKIP
) and tests (DREVOPS_TEST_SKIP
). - Added a flag to only build and export code
DREVOPS_EXPORT_CODE_ONLY
. - Updated PHPCS ruleset to not contain overrides. Any file-specific overrides (like delimiting comments) were moved into files.
- Renamed
master
tomain
in branch references. - Moved Behat screenshost directory under
tests/bats/screenshots
locally. - Added support for Behat test to pass tags from the env variable.
- Added Behat test reports to CI: they can now be accessed via
TEST
tab. - Added copying email to username after sanitization.
- Added Ahoy command to open DB in Sequel Ace.
- Added
ahoy doctor info
to gather information about OS to make debugging easier. - Updated ahoy commands descriptions.
Fixes
- Fixed DrevOps and Docker Compose env variables not being automatically passed to running containers from the host env. Allows to avoid specifying variables that need to be passed into containers.
- Fixed skipping of BDD test re-runs when ran on local.
- Fixed one-time Drupal link not shown on build.
- Fixed DB Docker image not using base Docker image if it does not exist.
- Fixed config_split warning during site install if it is not available.
- Fixed only lint FE assets if FE theme has them and do not re-run FE assets compilation on host in CI to speed up build time.
- Fixed
.editorconfig
being overridden oncomposer update
. - Fixed deployment script to correctly handle deployment of skipped branches.
- Fixed email not being passed to site install from profile during installation.
- Fixed PHPCS ruleset to not scan
.js
files for uppercaseTRUE
/FALSE
. - Fixed sanitized passwords not being set to a random password by default during site install.
- Fixed failed deployments not failing CI.
- Fixed incorrect Drush was used for retrieving a core version.
𧩠Integrations
Lagoon
- Added backing up of DB before deployment to production in Lagoon.
- Added support for specifying custom LagoonCLI version and Lagoon instance in Lagoon integration scripts.
- Added support for
LAGOON_PROJECT
variable in.env.
- Added showing of DrevOps variables during Lagoon rollout.
- Added custom Lagoon task runner script.
- Fixed Lagoon deployment failing if there are no environments.
- Fixed sites installed from profile to handle DB override correctly in Lagoon.
Acquia
- Fixed
TARGET_ENV_REMAP
variable in Acquia cache purge script. - Renamed
code
toartifact
deployment type to push to Acquia. - Updated
webhook
deployment to allow specifying the curl method. - Updated notification hooks for Acquia.
- Fixed sanitize script not working in non-prod environments.
π Documentation
- Updated PR template to use checklist s instead of comments.
- Simplified README.md file.
- Added quickstart placeholder docs section.
- Added docs publishing to docs.drevops.com.
- Added a script to scan for shell variables and auto-generate docs.
Other
- Updated condition check for all boolean variables: use explicit
1
for a truthful value. This is to allow overriding of the value without unsetting a variable. - Fixed unequal operator to be POSIX compliant in all scripts.
- Moved workflow tests into a separate CI job to ease DrevOps maintenance.
- Improvements in the DrevOps test system:
- Updated Bats testing framework to Bats 1.7 and updated several helpers.
- Updated Docker image workflow tests and added ARM support for tests.
- Added DrevOps helpers test to the CI pipeline.
- Updated Docker-Compose test fixtures.
- Updated installer script:
- Fixed theme discovery in installer.
- Updated installer path to use https://install.drevops.com
- Updated installer to use install from profile and override DB variables.
- Fixed installer to remove deploy job CI config when an option without a deployment is selected.
Apple M1 support!
Docker
- Updated images to be compatible with Apple M1 (thank to AmazeeIO for releasing images https://hub.docker.com/u/uselagoon).
- Added python and gcc to support Node packages compiling on M1.
CI and workflow
- Added
ahoy composer
. - Fixed
BUILD_VERBOSE
variable name. - Updated Drupal install script to be more verbose.
- Added skipping of deployments using env variables
DEPLOY_SKIP_PR_<NUMBER>
andDEPLOY_SKIP_BRANCH_<SAFE_BRANCH>
.
Integrations
- Fixed Lagoon deployment to use moved Lagoon CLI binary.
- Fixed download from Lagoon script not using specified SSH key if multiple keys are loaded (permission denied on DB download).
- Updated Lagoon deployment script to support creating and deleting environments, including with fresh production database
Documentation
- Added documentation to handle additional M1 configuration.
Apple M1 support!
8.x-1.14 Added python and gcc to support Node packages compiling on M1.
Apple M1 support!
7.x-1.14 Added python and gcc to support Node packages compiling on M1.
First D9 release!
- All configuration and changes from 8.x-1.13
[8.x] Images updates to 21.7.0 and Composer 2
Docker
- Added Composer 2.
- Updated images to
21.7.0
and PHP 7.4. - Updated Xdebug flag value to use
true
for the new Docker images. Upstream #251
CI and workflow
- Updated behat-screenshot to the latest version.
- Updated behat-steps to use the new namespace. (#633)
- Updated behat-format-progress-fail to the latest version.
- Removed obsolete
AMAZEEIO_
variables in favour ofMARIADB_
. - Removed port check from builds on Linux.
- Added support for
DATABASE_SSH_FINGERPRINT
in CI. - Fixed parameter parsing within deployment notification script.
Back-end
- Added running of
post_update
hooks on core module install.
Front-end
- Updated FE development packages to the latest versions.
- Added
ahoy fei
command to install FE packages.
Integrations
- Fixed environment detection in Lagoon.
- Updated Lagoon config to use correct configuration for routes for production and development environments.
- Fixed Lagoon deployment not using production branch variable.
- Fixed Lagoon private registry password variable name.
- Fixed Lagoon dotfiles were not copied into container.
- Fixed DB being sanitised in Acquia.
Documentation
- Updated command descriptions and run all tests.
[7.x] Updated images to 21.7.0 and Composer 2
[8.x] Portability and stability.
This release concentrates on stability and portability.
DrevOps scripts are no longer altered as a part of install for every project. All configuration is managed through .env
file.
Docker
- Updated images to new Lagoon versioning schema based on year and month
20.10.1
. - Updated PHP to 7.4
- Updated code references to Amazee repositories (now using https://github.com/uselagoon/lagoon-images).
CI and workflow
- Added support for custom scripts to run after site install. This allows to prevent the need to directly modify DrevOps scripts for every project.
- Added JS and CSS to PHPCS lint target.
- Added additional PHPCS rules to enforce no empty lines before and after function opening.
- Fixed 'ahoy debug' not restarting
nginx
service. - Added support for local environment overrides using
.env.local
file. - Added
CONFIRM_RESPONSE
todefault.env.local
to suppress questions locally. - Fixed install script replacing content in binary files.
- Added suppressing of DB download flag (#618).
- Added conditional install of theme assets if the theme was provided. This allows to use DrevOps scripts without modifying them when a custom theme is not present (for example, with headless installations).
- Added enabling and disabling maintenance mode on build.
- Added re-running of failed Behat tests.
- Fixed DIDI failed tests affecting other CI builds (internal DrevOps utilities).
- Fixed Bats test helper to work with the latest Bats (internal DrevOps utilities).
- Fixed Drush lookup to always use local version before global.
Back-end
- Added post config import update Drush command
post-config-import-update
. Addresses this core issue https://www.drupal.org/project/drupal/issues/2901418. - Added Composer update changelog generator (used after
composer update
to nicely summarise the modified packages with links to release and compare URLs). - Added
$config_exclude_modules
variable to settings. - Fixed
config_split
not using correct configuration per environment. - Added support for npm assets packages for libraries. (#606)
- Switched to
drupal/core-dev
and updated package versions. (#611) - Updated drupal install scripts to support DB settings read from environment variables. (#603)
Front-end
- Removed obsolete minified theme file (cleanup).
Integrations
- Added Lagoon cloud routes to trusted host patterns in settings.
- Updated Lagoon integration settings. (#604)
- Added deployment notification script which sends emails on successful deployment.
Documentation
- Added FAQ item about debugging Behat tests.
Updates
8.x-1.11 Added test for Lagoon deployment.
[8.x] Database stored in Docker image
This release adds highly demanded and long overdue support for using databases stored in Docker image. Using this workflow allows to build large database images in CI overnight and download databases as a fresh image in the morning to use for development and as a cache in CI.
During development, rebuilding local environments for projects with large databases will no longer be a long process (due to the time it takes to import from the database dump), but rather a matter of restarting a container. On the large databases (>1G) the time is reduced from 15-20 minutes to 15-30 seconds.
Additionally, there is now a support for several database sources: files or docker registry. As a result - there is a support for the following workflows (simplified):
- Download the database from CURL/FTP/Acquia as a dump file -> Import the database -> Develop/run tests -> Deploy
- Download the database from CURL/FTP/Acquia as a dump file -> Import into the Docker database image -> Push image to the registry -> Use the image to develop/run tests -> Deploy
- Download the database from the previous version of the image -> Use the image to develop/run tests -> Deploy
CI configuration now allows to enable using the database cache (file or Docker image) from the builds ran on the previous days. It also now supports nightly builds to cache the database to be used in builds during the day (significant builds speedup).
Lastly, the installer script was rewritten in PHP to allow more robust parameters handling and better development speed. It has own PHPUnit tests and updated Bats integration tests.
And of course, all the new functionality has automated tests.
Docker
- Updated images to Lagoon
v1.4.1
. - Updated Docker Compose configuration to support custom database image taken from
DATABASE_IMAGE
environment variable. - Removed quite pulling of the images. This is due to requests from developers to see which images were cached and which were downloaded during the build.
CI
- ββAdded support for nightly database builds + test.
- βAdded support for per-workflow caching.
- Added support for cache fallback with a switch - using per-branch build caches from previous days.
- Increased database job timeout in CI to 30 minutes.
Scripts
- π₯π₯π₯ Rewritten installer in PHP.
- Better installer written in PHP + complies with Drupal coding standards.
- Installer is interactive by default (previsously was quiet).
- Added PHPunit tests for installer.
- Updated existing integration Bats tests for installer.
- Fixed several issues with automated configuration discovery for existing projects.
- Installer now always overrides existing files during an update.
- π₯π₯π₯ Added support for database-in-Docker-image. This allows to work with DB image with in-built data.
- βββ Use https://github.com/drevops/mariadb-drupal-data as a base image + DB seeding script is included.
- βββ Workflow switch is controlled by
DATABASE_IMAGE
environment variable (one variable to controll the whole workflow). - ββ Added support for exporting image as archive. Used by CI to pass built images between jobs as cache and re-use this cache in the subsequent jobs.
- β Added support for deploying an image to a registry when exporting (if
EXPORT_DB_DEPLOY_DOCKER
is set). - Added
reload-db
command. Used to quickly restart database image. - Added
ahoy pull-db
command. Used to pull the latest version of the Database image.
- Added support for deployment of multiple docker images to Docker registry (according to provided service-to-image map).
- Added support for archiving and un-archiving of Docker images.
- Removed DrevOps test files from the downloadable package. This makes the downloadable archive cleaner.
- Moved DrevOps' tests and documentation under
scripts/drevops
directory. - Added
VERBOSE_BUILD
variable to show the build progress. - Added linting of Bats tests with Shellcheck.
- Improved bats test helpers and assertions.
- Added confirmations to
ahoy build
andahoy down
commands.
Back-end
- Removed Gherkin patch to run single tests with release of
behat/gherkin
version4.6.1
. - Fixed cron running locally and in CI.
Front-end
No changes
Integrations
- Added support for ODE environments in Acquia (settings and hooks).
- Acquia is no longer an integration enabled by default.
- Lagoon is no longer an integration suggested by default.
Documentation
- Added more documentation in comments to
.env
file. - Added more FAQs.
- Added documentation scaffolding (still WIP).