trackleft/az-quickstart-scaffolding

适用于Composer的亚利桑那快速启动框架


README

备注

如果您计划将此网站推送到Pantheon,您应使用 Pantheon上游存储库 作为您的框架存储库,它具有单独的说明。

Security workflow

为您的快速启动项目选择正确的分支

在亚利桑那快速启动框架项目中,不同的分支服务于不同的目的。以下是一个指南,说明您应该选择哪个分支

主分支(dev-main

  • 用途:主分支包含所有最新的功能和更改。它代表了前沿的开发,可能不如特定版本分支稳定。您可以使用它与 dev-main 或最新未发布版本的别名(例如,2.8.x)。
  • 何时使用:如果您想访问最新的功能,并且愿意处理可能未充分测试的代码,请选择此分支。理想用于开发、实验或测试未发布的功能。

发布分支(例如,2.5.x2.6.x2.7.x

  • 用途:以 2.x.x-dev 格式命名的发布分支是为项目的特定版本创建的,被认为是稳定且可用于生产的。它们包含适合生产环境的经过充分测试的功能。
  • 何时使用:如果您需要用于生产的项目稳定版本,有特定的环境限制,或希望与特定的第三方模块或特定版本保持兼容,请选择最新两个受支持的发布分支之一(例如,2.7.x-dev2.6.x-dev)。
  • 注意:仅支持最新两个发布分支。使用这些分支确保您收到更新、安全补丁和支持,与您的系统要求保持一致,避免潜在冲突,实现强大可靠的实施。
  • 受支持的发布分支中的版本约束:此存储库中每个受支持的发布分支在composer.json中指定了az_quickstart的版本约束。此约束确保发布分支将与兼容的Quickstart版本一起工作,该版本对应于兼容的次要版本分支,在提供灵活性的同时保持与预期版本的协调一致。

功能或问题分支

此存储库中的功能或问题分支通常创建用于更新框架以与az-digital/az_quickstart的特定分支一起工作。在创建此类分支时,通常会将此存储库的composer.json中对az-digital/az_quickstart的引用固定到特定的问题/功能分支,这些更改旨在与其一起工作。这确保了分支的更改与Quickstart项目的特定状态精确一致。

这些分支对于独立开发、更改测试或添加与Quickstart项目发展相对应的新功能到脚手架非常有用。

备注

  • 如果正在开发针对 az-digital/az_quickstart 的功能,请使用提供的构建工具(DDev或Lando),而不是直接运行composer create-project
  • 这些分支不如主分支或发布分支稳定,因此请将它们用于开发、实验或测试,而不是在生产环境中使用。
  • 此存储库中功能分支或问题分支的使用与az-digital/az_quickstart项目的发展紧密一致,应与相应的Quickstart分支一起使用。

使用 composer create-project 命令

使用Composer的create-project命令,您可以使用亚利桑那快速启动脚手架快速搭建新项目。每个az-quickstart-scaffolding分支与一个az_quickstart分支相对应,确保脚手架与核心项目之间的兼容性和一致性。

以下是一些如何使用不同分支规范使用此命令的示例

如果使用以下任何命令,请将my_project_name调整为您的期望项目目录名称。

  • 使用主分支(main)与开发依赖项:

    composer create-project az-digital/az-quickstart-scaffolding:dev-main my_project_name --no-interaction
    
  • 使用最新未发布版本的别名(2.8.x

    composer create-project az-digital/az-quickstart-scaffolding:2.8.x-dev my_project_name --no-interaction --no-dev
  • 使用特定发布分支(例如,2.7.x

    composer create-project az-digital/az-quickstart-scaffolding:2.7.x-dev my_project_name --no-interaction --no-dev
  • 使用问题或功能分支(例如,issue-45

    composer create-project az-digital/az-quickstart-scaffolding:dev-issue/45 my_project_name --no-interaction

Lando中的迁移设置

亚利桑那数字已经添加了一个迁移到Quickstart 2的README

更新Quickstart

目前,亚利桑那数字支持亚利桑那快速启动的两个最新次要版本

  • composer install将安装更新并拉入开发依赖项,如果存在,还将应用补丁。
  • composer install --no-dev将安装更新,并移除开发依赖项,如果存在,还将应用补丁。
  • composer update应根据您的composer.json文件中的版本约束获取最新版本,如果存在,还将应用补丁。
  • composer require "az-digital/az_quickstart:2.7.0" --update-no-dev将固定到Quickstart的特定版本,而不包括开发依赖项。您可以在需要更新时更新您的网站,增加版本号,或使用版本约束与composer update --no-dev仅更新到标记的版本。

一旦您的网站代码库更新到最新,运行数据库更新和分发更新就很重要了。

重要在运行数据库更新或导入分发更新之前,始终创建备份。

可以通过命令行更新数据库

drush updatedb

重要始终确保您的网站已设置正确的策略来导入分发更新。对于Quickstart,建议在导入分发更新时使用合并策略,这可以通过drush或管理员UI设置。

建议您熟悉配置分发模块的功能,以充分利用Quickstart。

drush -y state:set config_sync.update_mode 1 --input-format=integer

可以通过命令行导入分发更新

drush config-distro-update

启动您的网站

当您准备好启动网站时,您可以使用composer删除Quickstart和此脚手架存储库中包含的开发依赖项,但在这样做之前,您需要确保开发模块在Drupal中未启用。

示例

drush pm:uninstall -y devel migrate_devel config_inspector

一旦卸载,开发依赖项可以安全地通过composer删除。

composer remove --dev