피처 플래그 뒤에 배포된 문서 기능
GitLab v19.4요약
GitLab은 자체 기능의 배포를 단계적으로 진행하기 위해 피처 플래그를 사용합니다. 피처 플래그의 상태를 변경한 개발자가 문서를 갱신할 책임이 있습니다. 어떤 환경(GitLab Self-Managed, GitLab.com, GitLab Dedicated)에서 모든 고객을 대상으로 피처 플래그가 활성화되기 전에 해당 기능을 문서화해야 합니다.
GitLab은 자체 기능의 배포를 단계적으로 진행하기 위해 피처 플래그를 사용합니다.
Note
피처 플래그의 상태를 변경한 개발자가 문서를 갱신할 책임이 있습니다.
피처 플래그 뒤의 기능을 문서화할 시점#
어떤 환경(GitLab Self-Managed, GitLab.com, GitLab Dedicated)에서 모든 고객을 대상으로 피처 플래그가 활성화되기 전에 해당 기능을 문서화해야 합니다.
플래그 뒤에 있는 그 밖의 모든 기능은 해당 그룹의 PM 또는 EM 이 문서화 여부를 결정합니다.
기능과 함께 플래그를 문서화하지 않더라도, 플래그는 중앙 페이지에 자동으로 문서화됩니다.
피처 플래그 문서 추가 방법#
피처 플래그를 문서화하는 방법은 다음과 같습니다.
Offerings#
offerings를 문서화할 때, GitLab Self-Managed에서 비활성화된
기능에는 해당 기능의 offering으로 GitLab Dedicated를 적지 않습니다.
히스토리 텍스트 추가#
플래그의 상태가 바뀌면(예: 기본 비활성화에서 기본 활성화로) 그 변경 사항을 히스토리에 추가합니다.
히스토리 항목으로 사용할 수 있는 예시는 다음과 같습니다.
- [Introduced](https://issue-link) in GitLab X.X [with a feature flag](../../administration/feature_flags/_index.md) named `flag_name`. Disabled by default.
- [Enabled on GitLab.com](https://issue-link) in GitLab X.X.
- [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab X.X.
- [Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated](https://issue-link) in GitLab X.X.
- [Generally available](https://issue-link) in GitLab X.Y. Feature flag `flag_name` removed.
이 항목이 모든 상황에 맞지는 않습니다. 필요에 맞게 조정할 수 있습니다. 예를 들어 플래그가 특정 그룹, 프로젝트, 또는 일부 사용자에게만 활성화될 수 있습니다. 그런 경우에는 다음과 같은 히스토리 항목을 사용할 수 있습니다.
- [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 문서 사이트에서 다음과 같이 렌더링됩니다.
<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>
## 히스토리 예시
다음 예시는 피처 플래그의 진행 과정을 보여 줍니다. 변경이 있을 때마다 히스토리를 갱신합니다.
```markdown
- [Introduced](https://issue-link) in GitLab 13.7 [with a feature flag](../../administration/feature_flags/_index.md) named `forti_token_cloud`. Disabled by default.
<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>```
GitLab.com에서 기능이 기본으로 활성화되면 다음과 같습니다.
```markdown
- [Introduced](https://issue-link) in GitLab 13.7 [with a feature flag](../../administration/feature_flags/_index.md) named `forti_token_cloud`. Disabled by default.
- [Enabled on GitLab.com](https://issue-link) in GitLab 13.8.
<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에서 기능이 기본으로 활성화되면 다음과 같습니다.
```markdown
- [Introduced](https://issue-link) in GitLab 13.7 [with a feature flag](../../administration/feature_flags/_index.md) named `forti_token_cloud`. Disabled by default.
- [Enabled on GitLab.com](https://issue-link) in GitLab 13.8.
- [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 13.9.
<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>```
플래그가 제거되면 `Generally available` 항목을 추가합니다. 이때 `FLAG` 노트도 함께 삭제합니다.
```markdown
- [Introduced](https://issue-link) in GitLab 13.7 [with a feature flag](../../administration/feature_flags/_index.md) named `forti_token_cloud`. Disabled by default.
- [Enabled on GitLab.com](https://issue-link) in GitLab 13.8.
- [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 13.9.
- [Generally available](https://issue-link) in GitLab 14.0. Feature flag `forti_token_cloud` removed.
피처 플래그가 같은 릴리스에서 도입되고 제거되었다면, 히스토리에서 피처 플래그 항목과 플래그 노트를 삭제합니다.
긴 히스토리 단순화#
히스토리는 길어질 수 있지만, 경우에 따라 항목을 단순화하거나 삭제할 수 있습니다.
같은 릴리스에서 일어난 항목은 하나로 합칩니다.
-
변경 전:
- [Introduced](https://issue-link) in GitLab 14.2 [with a feature flag](../../administration/feature_flags/_index.md) named `ci_include_rules`. Disabled by default. - [Enabled on GitLab.com](https://issue-link) in GitLab 14.3. - [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 14.3. -
변경 후:
- [Introduced](https://issue-link) in GitLab 14.2 [with a feature flag](../../administration/feature_flags/_index.md) named `ci_include_rules`. Disabled by default. - [Enabled on GitLab.com, GitLab Self-Managed, and GitLab Dedicated](https://issue-link) in GitLab 14.3.
피처 플래그가 같은 릴리스에서 도입되고 활성화되었다면 항목을 하나로 합칩니다.
- [Introduced](https://issue-link) in GitLab 17.7 [with a feature flag](../../administration/feature_flags/_index.md) named `forti_token_cloud`. Enabled by default.
히스토리 상세에 한 기능에 대한 피처 플래그가 여러 개 있다면, 가독성을 높이기 위해 중첩 목록으로 기능과 함께 묶을 수 있습니다.
-
변경 전:
- [Introduced](https://issue-link) in GitLab 18.3 [with feature flags](../../administration/feature_flags/_index.md) named `flag_one` and `flag_two`. Disabled by default. - [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 18.4. - Dependency report sidepanel [introduced](https://issue-link) in GitLab 18.4 [with feature flags](../../administration/feature_flags/_index.md) named `flag_one` and `flag_two`. Disabled by default. - Dependency report sidepanel [enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 18.5. - Dependency report sidepanel [generally available](https://issue-link) in GitLab 18.6. Feature flags `flag_one` and `flag_two` removed. -
변경 후:
- [Introduced](https://issue-link) in GitLab 18.3 [with feature flags](../../administration/feature_flags/_index.md) named `flag_one` and `flag_two`. Disabled by default. - [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 18.4. - Dependency report sidepanel: - [Introduced](https://issue-link) in GitLab 18.4 [with feature flags](../../administration/feature_flags/_index.md) named `flag_one` and `flag_two`. Disabled by default. - [Enabled on GitLab Self-Managed and GitLab Dedicated](https://issue-link) in GitLab 18.5. - [Generally available](https://issue-link) in GitLab 18.6. Feature flags `flag_one` and `flag_two` removed.
Enabled on GitLab.com 항목은 모든 offering에서 기능이 기본으로 활성화되고 플래그가 제거된 경우에만 삭제합니다.
-
변경 전:
- [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.com](https://issue-link) in GitLab 15.7. - [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. -
변경 후:
- [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.