WRI/wri-starter-kit

在Pantheon上使用Composer安装基于drops-8的配置文件。

10.0.2 2024-09-23 17:01 UTC

README

为wri网站提供入门代码

基于 https://github.com/pantheon-systems/example-drops-8-composer,并进行了一些更新,以便使用wri/wri_sites https://github.com/wri/wri_sites配置安装。

构建新网站

  1. 确保您已经拥有所有使用Pantheon构建工具的先决条件,如https://pantheon.io/docs/guides/build-tools/create-project/#prerequisites中所述。

请注意,包括以下内容

  • Composer版本2+
  • terminus版本3+
  • 在Pantheon仪表板上有一个SSH密钥(这样您可以在不提供密码的情况下运行terminus命令)
  • terminus构建工具插件

您还应该有

  • 在Github WRI组织下创建新仓库的能力: https://github.com/organizations/wri/repositories/new
  • 在Pantheon下WRI组织创建新网站的能力(在您的Pantheon仪表板上,使用左上角的图标转到WRI组织,然后查找“创建新网站”按钮)
  1. 确保您正在运行Composer版本2:composer self-update --2,然后运行此命令

    COMPOSER_MEMORY_LIMIT=-1 terminus build:project:create --team='8d0668c5-17bd-17c8-6fd2-1e81cddff66f' --org='wri' --visibility='private' --stability='dev'  wri/wri-starter-kit [new-project-name]
    

    有关构建工具和每个部分含义的更多信息,请参阅 https://github.com/pantheon-systems/terminus-build-tools-plugin/blob/master/README.md#buildprojectcreate

    如果您遇到内存耗尽错误,请跳转到“如果build:project命令失败时应做什么 - 手动创建”部分。

  2. 在您的新网站上启用solr

    terminus solr:enable [new-project-name]
    
  3. 您现在可以访问您的github仓库,网址为 https://github.com/wri/[new-project-name]。该仓库的README.md中将包含有关Pantheon multidev和Circleci配置的信息。

  4. 使用 https://github.com/wri/[new-project-name]/settings 将主分支重命名为“main”。

  5. 很可能有一个新分支等待合并,其中包含安装您的网站后显示的配置更改。为该分支创建一个PR到您的repo的“main”分支。

  6. 在PR中,如果settings.php包含添加数据库连接的行,请删除这些更改并推送: git checkout main web/sites/default/settings.php

  7. 还更新了构建文件之一的权限,并将其推送到PR: chmod 755 ./.ci/build/multidev-save

  8. 将PR合并到“main”分支。

安装后推荐进行的配置更改

在初始安装后,我们建议您执行以下操作

  1. 将您的网站从dev -> test -> live拉取,这样您就可以在无需担心新部署会丢失它们的情况下开始进行配置更改。
  2. 在live上,启用wri_packagewri_package2模块。
  3. 在live上,将用户1的用户名更改为“admin”以外的名称,并为其设置一个更强的密码。
  4. 在live上,创建一个主页 /node/add/homepage
  5. 在live上,在/admin/config/system/site-information创建网站标题等,包括链接到您刚刚创建的主页。
  6. 在网站上线时,设置您希望在该网站上使用的任何语言。文档:https://www.drupal.org/docs/multilingual-guide
  7. 使用位于 /admin/config/development/configuration/single/config-partial-exportconfig_partial_export 模块将实时配置导回到代码库。

如果构建:项目命令失败,应该怎么做

  1. 首先尝试删除网站:https://github.com/wri/wri-starter-kit#how-to-delete-a-project-made-with-this-starter-kit
  2. 如果这失败了,请手动删除 GitHub 仓库和 Pantheon 环境。
  3. 修复导致网站构建失败的问题
  4. 重新运行 terminus build:project:create

手动创建

如果在配置安装期间自动工具遇到内存耗尽错误,我们需要手动安装/设置构建工具。

(以下步骤假设您已经运行了 COMPOSER_MEMORY_LIMIT=-1 terminus build:project:create --team='World Resources Institute' --org='wri' --visibility='private' --stability='dev' wri/wri-starter-kit [new-project-name] 并且尚未运行/更改任何内容。)

构建代码库
  1. 在本地运行 COMPOSER_MEMORY_LIMIT=-1 composer create-project wri/wri-starter-kit [new-project-name]
    1. 这将构建本地项目(减去配置安装)
  2. 运行 cd [new-project-name]
  3. 如果未使用 docksal,则跳过此步骤
    1. https://github.com/wri/wriflagship 复制 .docksal/ 目录并将其粘贴到项目中。
    2. 运行 fin init
  4. 现在运行(如果使用 docksal 则添加 fin):drush site-install wri_sites --account-mail='<site-email>' --account-name=<admin-account-username> --account-pass="<admin-password" --site-mail='<site-email>' --site-name=<new-project-name> --yes
  5. 现在导出数据库
设置数据库
  1. 登录 Pantheon 并导航到您的新网站
  2. Dev 选项卡下,转到 Database / File --> Import
  3. 导入您在上一个部分导出的数据库
CI 工具(CircleCi)
  1. 前往:https://app.circleci.com/projects/project-dashboard/github/wri/
  2. 找到您的新网站并点击它
  3. 验证没有错误,如果有错误,例如“分支未找到”,请修复它们。
最终步骤
  1. 在 github 中,导航到您新网站的项目仓库
  2. 将其克隆到新项目目录旁边。(您需要重命名其中一个目录以避免冲突,或放在不同的位置)
  3. 一旦克隆完成,将新鲜克隆的仓库中的 .git 目录复制到您之前创建的项目目录中。这将成为您项目的新的工作 git 目录。(这只是将所有生成的文件放入 git 已知的目录的一种快速方法)
  4. 如果一切看起来正确,请提交并推送到仓库。
  5. 在 github、circle ci 和 pantheon 中验证所有管道是否正常工作。推送到仓库应触发构建。

如何删除使用此启动套件创建的项目。

Pantheon 构建工具 提供了一个 build:env:obliterate 命令来删除使用 build:project:create 命令启动的网站。它将删除 Pantheon 网站和仓库,因此您在任一位置所做的任何更改都将永远丢失。示例

terminus build:env:obliterate [new-project-name]