專案設定

專案組態檔位於 /.helix/config.xlsx (適用於sharepoint)或 /.helix/config (適用於google drive)。 它是由表格組成,使用 Keyvalue 欄。 例如:

金鑰的格式會依循識別碼點標籤法,就像在javascript中一樣。 您可以將工作表視為平面化JSON結構。 如果一個鍵出現多次,則會形成一個陣列,例如:

在概念上將會是類似以下的結構:

{
  "access": {
    "allow": [
      "*@adobe.com",
      "*@example.com",
    ]
  }
}

下表列出專案的組態選項。

代碼--------------v---------------

name --------------v--------------- slack --------------v--------------- host --------------v--------------- timezone --------------v--------------- cdn.prod.host --------------v--------------- cdn.prod.type --------------v---------------

cdn.prod.route --------------v--------------- cdn.prod.serviceId --------------v--------------- cdn.prod.authToken --------------v--------------- cdn.prod.endpoint --------------v--------------- cdn.prod.clientSecret --------------v--------------- cdn.prod.clientToken --------------v--------------- cdn.prod.accessToken --------------v--------------- cdn.prod.origin --------------v--------------- cdn.prod.plan --------------v--------------- cdn.prod.zoneId --------------v--------------- cdn.prod.apiToken --------------v---------------

access.allow --------------v---------------

access.require.repository --------------v---------------

admin.role.author --------------v---------------

admin.role.publish --------------v---------------

blueprint --------------v---------------

admin.events.github.target

評論-------------------v------------------- Slack機器人在報告時使用的專案名稱。 -------------------v-------------------此專案的Slack頻道-------------------v-------------------主機顯示於Slack機器人資訊-------------------v-------------------Slack機器人使用的時區-------------------v------------------- CDN主機名稱-------------------v------------------- CDN型別-------------------v-------------------路由或以Franklin -------------------v------------------- Fastly呈現的CDN上的路由:服務ID -------------------v------------------- Fastly特定: API權杖-------------------v------------------- Akamai特定:使用者端密碼-------------------v------------------- Akamai特定:訪問令牌-------------------v------------------- Cloudflare特定:原始-------------------v------------------- Cloudflare特定:計畫-------------------v------------------- Cloudflare特定:區域id -------------------v------------------- Cloudflare特定: api令牌-------------------v-------------------------------------- ------------------- ------------------- -------------------允許使用者的電子郵件glob。 如果設定,這將啟用網站驗證。 -------------------v-------------------允許使用此內容的專案的擁有者/存放庫指標清單。 -------------------v-------------------具有作者角色之使用者的電子郵件glob。 -------------------v-------------------具有發佈角色之使用者的電子郵件glob。 所有者/存放庫格式的-------------------v-------------------設定blueprint存放庫。 可以是多個。 -------------------v-------------------要傳送通知的目標Github存放庫。

範例------------v------------

富蘭克林網站------------v------------ T03DFTYDQ/C12U1A8480Q ------------v------------ www.hlx.live ------------v------------歐洲/蘇黎世------------v------------ www.hlx.live ------------v------------ fastly ------------v------------

/site ------------v------------ 1234 ------------v------------

------------v------------

------------v------------

------------v------------

------------v------------

------------v------------

------------v------------

------------v------------

------------v------------

------------v------------

*@adobe.com ------------v------------

adobe/helix-website ------------v------------

*@adobe.com ------------v------------

*@adobe.com ------------v------------

adobe/franklin-defaults ------------v------------

hlxsites/target-gh-repo

另請參閱 JSON結構描述Typescript型別 此設定的。

BluePrint

專案可以定義作為設定預設的設定Blueprint。

藍圖定義於 .helix github存放庫的目錄。 例如:

adobe/franklin-defaults
  ├── README.md
  ├── .helix/
  │   ├── blueprint-targets.json
  │   └── blueprint-config.json
  └── fstab.yaml
  • .helix/blueprint-config.json 包含Blueprint設定
  • .helix/blueprint-targets.json 包含可使用Blueprint的允許專案清單

blueprint-targets.json 必須是具有擁有者/存放庫名稱的JSON陣列,例如:

[
    "adobe/franklin-project1",
    "adobe/franklin-project2"
]

每個想要使用Blueprint的專案都需要使用 blueprint 中的屬性 .helix/config.json (請參閱上述組態選項),並列於 .helix/blueprint-targets.json 在blueprint設定存放庫中。

此雙向參考是必要的,以確保沒有任何專案可以 竊取 另一個的組態,
而且任何Blueprint存放庫都無法在不相關的專案上強制進行設定。

注意:Blueprint設定僅在個別設定檔案(/.helix/config, /.helix/headers/metadata)已預覽,但在推送Blueprint設定時不會預覽。

藍圖包含專案設定的預設值(如上所述)。 他們還可以提供 標頭中繼資料 設定且具有下列結構:

{
  "config": {
    "data": {
      ....project config
    }
  },
  "metadata": {
    "data": {
      ....metadata config
    }
  },
  "headers": {
    "data": {
      ....headers config
    }
  }
}

中繼資料和標題設定遵循修飾元格式,這是路徑glob物件中的索引鍵/值配對陣列。 例如:

"metadata": {
    "data": {
      "/news/**": [
        {"key": "category", "value": "news"},
        {"key": "locale", "value": "en-US"}
      ],
      "/blog/**": [
        {"key": "category", "value": "blog"}
      ],
      "/**": [
        {"key": "title", "value": "ACME CORP"},
        {"key": "description", "value": "Lorem ipsum dolor…"},
        {"key": "locale", "value": "en-US"}
      ]
    },
  },
}
recommendation-more-help
10a6ce9d-c5c5-48d9-8ce1-9797d2f0f3ec