记录通过功能标志部署的功能

GitLab 使用 功能标志 来部署其自身功能。

何时记录功能标志背后的功能

在功能标志为环境中所有客户（GitLab 自托管、GitLab.com 或 GitLab Dedicated）启用之前，必须记录该功能。

对于其他所有标志背后的功能，该组的 PM 或 EM 决定是否记录该功能。

即使标志没有与功能一起记录，它也会在中央页面上自动记录。

如何添加功能标志文档

要记录功能标志：

• 添加历史文本。
• 添加标志说明。

产品版本

在记录 产品版本 时，对于在 GitLab 自托管上禁用的功能，不要将 GitLab Dedicated 列为该功能的产品版本。

添加历史文本

当标志状态发生变化时（例如，从默认禁用变为默认启用），将更改添加到 历史记录 中。

可能的历史记录条目如下：

{{< history >}}

- [引入](https://issue-link) 于 GitLab X.X [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `flag_name`。默认禁用。
- [在 GitLab.com 上启用](https://issue-link) 于 GitLab X.X。
- [在 GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab X.X。
- [在 GitLab.com、GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab X.X。
- [正式发布](https://issue-link) 于 GitLab X.Y。功能标志 `flag_name` 已移除。

{{< /history >}}

这些条目可能不适合所有场景。你可以根据需要进行调整。 例如，标志可能仅为某个组、项目或用户子集启用。 在这种情况下，你可以使用类似的历史记录条目：

- [在 GitLab.com 上启用](https://issue-link) 于 GitLab X.X，面向部分用户。

添加标志说明

在主题开始处添加此功能标志说明，就在历史记录下方。

最后一句（not ready for production use）是可选的。

{{< alert type="flag" >}}

此功能的可用性由功能标志控制。
有关更多信息，请参阅历史记录。
此功能可用于测试，但尚未准备好用于生产环境。

{{< /alert >}}

此说明在 GitLab 文档网站上呈现为：

历史记录示例

以下示例展示了功能标志的进展。每次更改时都更新历史记录：

{{< history >}}

- [引入](https://issue-link) 于 GitLab 13.7 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `forti_token_cloud`。默认禁用。

{{< /history >}}

{{< alert type="flag" >}}

此功能的可用性由功能标志控制。有关更多信息，请参阅历史记录。

{{< /alert >}}

当功能在 GitLab.com 上默认启用时：

{{< history >}}

- [引入](https://issue-link) 于 GitLab 13.7 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `forti_token_cloud`。默认禁用。
- [在 GitLab.com 上启用](https://issue-link) 于 GitLab 13.8。

{{< /history >}}

{{< alert type="flag" >}}

此功能的可用性由功能标志控制。有关更多信息，请参阅历史记录。

{{< /alert >}}

当功能对所有产品版本默认启用时：

{{< history >}}

- [引入](https://issue-link) 于 GitLab 13.7 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `forti_token_cloud`。默认禁用。
- [在 GitLab.com 上启用](https://issue-link) 于 GitLab 13.8。
- [在 GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab 13.9。

{{< /history >}}

{{< alert type="flag" >}}

此功能的可用性由功能标志控制。有关更多信息，请参阅历史记录。

{{< /alert >}}

当标志被移除时，添加一个 正式发布 条目。确保同时删除 FLAG 说明：

{{< history >}}

- [引入](https://issue-link) 于 GitLab 13.7 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `forti_token_cloud`。默认禁用。
- [在 GitLab.com 上启用](https://issue-link) 于 GitLab 13.8。
- [在 GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab 13.9。
- [正式发布](https://issue-link) 于 GitLab 14.0。功能标志 `forti_token_cloud` 已移除。

{{< history >}}

简化长历史记录

历史记录可能会很长，但有时你可以简化或删除条目。

如果条目在同一版本中发生，请合并它们：

• 之前：

  - [引入](https://issue-link) 于 GitLab 14.2 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `ci_include_rules`。默认禁用。
  - [在 GitLab.com 上启用](https://issue-link) 于 GitLab 14.3。
  - [在 GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab 14.3。

• 之后：

  - [引入](https://issue-link) 于 GitLab 14.2 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `ci_include_rules`。默认禁用。
  - [在 GitLab.com、GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab 14.3。

如果功能标志在同一版本中被引入和启用，请合并条目：

- [引入](https://issue-link) 于 GitLab 17.7 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `forti_token_cloud`。默认启用。

仅在功能对所有产品版本默认启用且标志被移除时，删除 在 GitLab.com 上启用 条目：

• 之前：

  {{< history >}}
  
  - [引入](https://issue-link) 于 GitLab 15.6 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `ci_hooks_pre_get_sources_script`。默认禁用。
  - [在 GitLab.com 上启用](https://issue-link) 于 GitLab 15.7。
  - [在 GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab 15.8。
  - [正式发布](https://issue-link) 于 GitLab 15.9。功能标志 `ci_hooks_pre_get_sources_script` 已移除。
  
  {{< /history >}}

• 之后：

  {{< history >}}
  
  - [引入](https://issue-link) 于 GitLab 15.6 [通过一个标志](../../administration/feature_flags/_index.md) 命名为 `ci_hooks_pre_get_sources_script`。默认禁用。
  - [在 GitLab 自托管和 GitLab Dedicated 上启用](https://issue-link) 于 GitLab 15.8。
  - [正式发布](https://issue-link) 于 GitLab 15.9。功能标志 `ci_hooks_pre_get_sources_script` 已移除。
  
  {{< /history >}}