GitLab은 피처 플래그를 사용하여 자체 기능의 배포를 단계적으로 출시합니다.

피처 플래그의 상태를 변경하는 개발자는 문서를 업데이트할 책임이 있습니다.

피처 플래그 뒤의 기능을 문서화할 시점#

환경(GitLab Self-Managed, GitLab.com, 또는 GitLab Dedicated)의 모든 고객에게 피처 플래그가 활성화되기 전에 해당 기능은 반드시 문서화되어야 합니다.

플래그 뒤에 있는 다른 모든 기능의 경우, 해당 그룹의 PM 또는 EM이 기능 문서화 여부를 결정합니다.

플래그가 기능과 함께 문서화되지 않은 경우에도, 중앙 페이지에 자동으로 문서화됩니다.

피처 플래그 문서 추가 방법#

피처 플래그를 문서화하려면:

• 히스토리 텍스트 추가.

• 플래그 노트 추가.

Offerings#

offerings를 문서화할 때, GitLab Self-Managed에서 비활성화된 기능에 대해서는 GitLab Dedicated를 해당 기능의 offering으로 나열하지 마세요.

히스토리 텍스트 추가#

플래그의 상태가 변경되면(예: 기본적으로 비활성화에서 기본적으로 활성화로), 해당 변경 사항을 히스토리에 추가합니다.

가능한 히스토리 항목은 다음과 같습니다:

<details class="history-toggle"><summary>히스토리</summary><ul><li><a href="https://issue-link">Introduced</a> in GitLab X.X <a href="/docs/gitlab/19.1/administration/feature_flags/">with a feature flag</a> named <code>flag_name</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab.com</a> in GitLab X.X.</li>
<li><a href="https://issue-link">Enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab X.X.</li>
<li><a href="https://issue-link">Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated</a> in GitLab X.X.</li>
<li><a href="https://issue-link">Generally available</a> in GitLab X.Y. Feature flag <code>flag_name</code> removed.</li></ul></details>

이 항목들이 모든 시나리오에 맞지 않을 수 있습니다. 필요에 맞게 조정할 수 있습니다. 예를 들어, 플래그가 그룹, 프로젝트, 또는 일부 사용자에게만 활성화될 수 있습니다. 그런 경우 다음과 같은 히스토리 항목을 사용할 수 있습니다:

- [Enabled on GitLab.com](https://issue-link) in GitLab X.X for a subset of users.

피처 플래그 변경 사항 추가#

여러 피처 플래그가 통합되거나 이후 릴리즈에서 피처 플래그 이름이 변경될 경우, 히스토리 항목에 해당 변경 사항을 언급합니다:

- [Introduced](https://issue-link) in GitLab X.X [with a feature flag](../../administration/feature_flags/_index.md) named `flag_name`. Disabled by default.
- Feature flag [changed](https://issue-link) to `new_flag_name` in GitLab X.X. Disabled by default. Feature flag `flag_name` removed.

플래그 노트 추가#

히스토리 바로 아래, 토픽의 시작 부분에 이 피처 플래그 노트를 추가합니다.

마지막 문장(not ready for production use)은 선택 사항입니다.

<div class="admonition tip"><div class="admonition-title">Feature flag</div>

The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.

</div>```

이 노트는 GitLab 문서 사이트에서 다음과 같이 렌더링됩니다:

    The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.

## 히스토리 예시

다음 예시는 피처 플래그의 진행 과정을 보여줍니다. 변경 사항이 있을 때마다 히스토리를 업데이트합니다:

히스토리

• Introduced in GitLab 13.7 with a feature flag named forti_token_cloud. Disabled by default.

```

GitLab.com에서 기능이 기본적으로 활성화된 경우:

<details class="history-toggle"><summary>히스토리</summary><ul><li><a href="https://issue-link">Introduced</a> in GitLab 13.7 <a href="/docs/gitlab/19.1/administration/feature_flags/">with a feature flag</a> named <code>forti_token_cloud</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab.com</a> in GitLab 13.8.</li></ul></details>

<div class="admonition tip"><div class="admonition-title">Feature flag</div>

The availability of this feature is controlled by a feature flag. For more information, see the history.

</div>```

모든 offering에서 기능이 기본적으로 활성화된 경우:

히스토리

• Introduced in GitLab 13.7 with a feature flag named forti_token_cloud. Disabled by default.
• Enabled on GitLab.com in GitLab 13.8.
• Enabled on GitLab Self-Managed and GitLab Dedicated in GitLab 13.9.

```

플래그가 제거된 경우, Generally available 항목을 추가합니다. FLAG 노트도 함께 삭제해야 합니다:

<details class="history-toggle"><summary>히스토리</summary><ul><li><a href="https://issue-link">Introduced</a> in GitLab 13.7 <a href="/docs/gitlab/19.1/administration/feature_flags/">with a feature flag</a> named <code>forti_token_cloud</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab.com</a> in GitLab 13.8.</li>
<li><a href="https://issue-link">Enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab 13.9.</li>
<li><a href="https://issue-link">Generally available</a> in GitLab 14.0. Feature flag <code>forti_token_cloud</code> removed.</li>
<li><a href="https://issue-link">Introduced</a> in GitLab 14.2 <a href="/docs/gitlab/19.1/administration/feature_flags/">with a feature flag</a> named <code>ci_include_rules</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab.com</a> in GitLab 14.3.</li>
<li><a href="https://issue-link">Enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab 14.3.</li>
<li><a href="https://issue-link">Introduced</a> in GitLab 14.2 <a href="/docs/gitlab/19.1/administration/feature_flags/">with a feature flag</a> named <code>ci_include_rules</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated</a> in GitLab 14.3.</li>
<li><a href="https://issue-link">Introduced</a> in GitLab 17.7 <a href="/docs/gitlab/19.1/administration/feature_flags/">with a feature flag</a> named <code>forti_token_cloud</code>. Enabled by default.</li>
<li><a href="https://issue-link">Introduced</a> in GitLab 18.3 <a href="/docs/gitlab/19.1/administration/feature_flags/">with feature flags</a> named <code>flag_one</code> and <code>flag_two</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab 18.4.</li>
<li>Dependency report sidepanel <a href="https://issue-link">introduced</a> in GitLab 18.4 <a href="/docs/gitlab/19.1/administration/feature_flags/">with feature flags</a> named <code>flag_one</code> and <code>flag_two</code>. Disabled by default.</li>
<li>Dependency report sidepanel <a href="https://issue-link">enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab 18.5.</li>
<li>Dependency report sidepanel <a href="https://issue-link">generally available</a> in GitLab 18.6. Feature flags <code>flag_one</code> and <code>flag_two</code> removed.</li>
<li><a href="https://issue-link">Introduced</a> in GitLab 18.3 <a href="/docs/gitlab/19.1/administration/feature_flags/">with feature flags</a> named <code>flag_one</code> and <code>flag_two</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab 18.4.</li>
<li>Dependency report sidepanel:</li>
<li><a href="https://issue-link">Introduced</a> in GitLab 18.4 <a href="/docs/gitlab/19.1/administration/feature_flags/">with feature flags</a> named <code>flag_one</code> and <code>flag_two</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab 18.5.</li>
<li><a href="https://issue-link">Generally available</a> in GitLab 18.6. Feature flags <code>flag_one</code> and <code>flag_two</code> removed.</li>
<li><a href="https://issue-link">Introduced</a> in GitLab 15.6 <a href="/docs/gitlab/19.1/administration/feature_flags/">with a feature flag</a> named <code>ci_hooks_pre_get_sources_script</code>. Disabled by default.</li>
<li><a href="https://issue-link">Enabled on GitLab.com</a> in GitLab 15.7.</li>
<li><a href="https://issue-link">Enabled on GitLab Self-Managed and GitLab Dedicated</a> in GitLab 15.8.</li>
<li><a href="https://issue-link">Generally available</a> in GitLab 15.9. Feature flag <code>ci_hooks_pre_get_sources_script</code> removed.</li></ul></details>

변경 후:

- [Introduced](https://issue-link) in GitLab 15.6 [with a feature flag](../../administration/feature_flags/_index.md) named `ci_hooks_pre_get_sources_script`. Disabled by default.
- [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 15.8.
- [Generally available](https://issue-link) in GitLab 15.9. Feature flag `ci_hooks_pre_get_sources_script` removed.