Requirements Management · Gitlab 中文文檔

# Requirements Management > 原文：[https://docs.gitlab.com/ee/user/project/requirements/](https://docs.gitlab.com/ee/user/project/requirements/) * [Create a requirement](#create-a-requirement) * [Edit a requirement](#edit-a-requirement) * [Archive a requirement](#archive-a-requirement) * [Reopen a requirement](#reopen-a-requirement) * [Search for a requirement](#search-for-a-requirement) * [Allow requirements to be satisfied from a CI job](#allow-requirements-to-be-satisfied-from-a-ci-job) * [Add the manual job to CI](#add-the-manual-job-to-ci) * [Specifying individual requirements](#specifying-individual-requirements) * [Add the manual job to CI conditionally](#add-the-manual-job-to-ci-conditionally) # Requirements Management[](#requirements-management-ultimate "Permalink") [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2703) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10. 根據要求，您可以設置標準來檢查產品. 它們可以基于用戶，涉眾，系統，軟件或您認為重要的其他任何內容. 需求是 GitLab 中的工件，用于描述產品的特定行為. 需求是長期存在的，除非手動清除，否則它們不會消失. 如果行業標準*要求*您的應用程序具有某些功能或行為，則可以[創建一個要求](#create-a-requirement)來反映這一點. 如果不再需要某個功能，則可以[歸檔相關需求](#archive-a-requirement) . 有關概述，請參見[GitLab 12.10 引入需求管理](https://www.youtube.com/watch?v=uSS7oUNSEoU) . [![requirements list view](https://img.kancloud.cn/90/38/90386d61be50919ecc9df888087350d7_1551x805.png)](img/requirements_list_v13_1.png) ## Create a requirement[](#create-a-requirement "Permalink") 每個項目都有一個分頁的需求清單，您可以在其中創建一個新需求. 創建需求： 1. 在您的項目頁面上，轉到 **要求** . 2. Click **新要求**. 3. 輸入描述性標題，然后單擊**創建需求** . 您將在列表頂部看到新創建的需求，因為需求列表按創建日期降序排列. ## Edit a requirement[](#edit-a-requirement "Permalink") 您可以從需求列表頁面編輯需求（如果您具有必要的特權）. 要編輯需求： 1. 在需求清單中，按一下[ **編輯** （）. 2. 在文本輸入字段中更新標題. 3. Click **保存更改**. ## Archive a requirement[](#archive-a-requirement "Permalink") 在" **打開"**選項卡中時，可以存檔一個未完成的需求（如果有必要的特權）. 要存檔需求，請點擊**存檔** （）. 需求存檔后，它不再出現在" **打開"**選項卡中. ## Reopen a requirement[](#reopen-a-requirement "Permalink") 您可以在"已**歸檔"**選項卡中查看已歸檔需求的列表. [![archived requirements list](https://img.kancloud.cn/14/60/14608eb689fd329e696e30acc7f08206_1549x307.png)](img/requirements_archived_list_view_v13_1.png) 要重新打開已歸檔的需求，請點擊**重新打開** . 重新打開需求后，它不再出現在" **歸檔"**選項卡中. ## Search for a requirement[](#search-for-a-requirement "Permalink") [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212543) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1. 您可以根據以下條件從需求列表頁面中搜索需求： * 要求標題 * 作者的用戶名要搜索需求： 1. 在一個項目中，轉到 **需求>清單** . 2. 單擊**搜索或過濾結果**字段. 出現一個下拉菜單. 3. 從下拉列表中選擇需求作者或輸入純文本以按需求標題進行搜索. 4. 在鍵盤上按`Enter`鍵以過濾列表. 您還可以通過以下方式對需求列表進行排序： * 創建日期 * 最近更新時間 ## Allow requirements to be satisfied from a CI job[](#allow-requirements-to-be-satisfied-from-a-ci-job "Permalink") 版本歷史 * 在[GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1 中[引入](https://gitlab.com/groups/gitlab-org/-/epics/2859) . * 在[GitLab Ultimate](https://about.gitlab.com/pricing/) 13.2 中[增加](https://gitlab.com/gitlab-org/gitlab/-/issues/215514)了指定個別要求及其狀態的功能. GitLab 現在支持[需求測試報告](../../../ci/pipelines/job_artifacts.html#artifactsreportsrequirements-ultimate) . 您可以將作業添加到 CI 管道，該作業在觸發時會將所有現有需求標記為"滿足". ### Add the manual job to CI[](#add-the-manual-job-to-ci "Permalink") 要配置您的 CI 以在觸發手動作業時將要求標記為"滿足"，請將以下代碼添加到`.gitlab-ci.yml`文件中. ``` requirements_confirmation: when: manual allow_failure: false script: - mkdir tmp - echo "{\"*\":\"passed\"}" > tmp/requirements.json artifacts: reports: requirements: tmp/requirements.json ``` 此定義將手動觸發的（ `when: manual` ）作業添加到 CI 管道. 它阻止了（ `allow_failure: false` ），但是由您決定觸發 CI 作業的條件是什么. 另外，您可以使用任何現有的 CI 作業將所有需求標記為已滿足，前提是 CI 作業生成并上傳了`requirements.json`工件. 當您手動觸發此作業時，包含`{"*":"passed"}`的`requirements.json`文件將作為工件上傳到服務器. 在服務器端，將檢查需求報告中的"所有通過"記錄（ `{"*":"passed"}` ），并在成功后將所有現有的打開需求標記為"滿意". #### Specifying individual requirements[](#specifying-individual-requirements "Permalink") 可以指定個別要求及其狀態. 如果存在以下要求： * `REQ-1` （具有 IID `1` ） * `REQ-2` （具有 IID `2` ） * `REQ-3` （具有 IID `3` ）可以指定第一個要求通過，第二個失敗. 有效值為"通過"和"失敗". 通過省略需求 IID（在這種情況下為`REQ-3`的 IID `3` ），沒有發現結果. ``` requirements_confirmation: when: manual allow_failure: false script: - mkdir tmp - echo "{\"1\":\"passed\", \"2\":\"failed\"}" > tmp/requirements.json artifacts: reports: requirements: tmp/requirements.json ``` ### Add the manual job to CI conditionally[](#add-the-manual-job-to-ci-conditionally "Permalink") 要將 CI 配置為僅在有某些開放要求時才包括手動作業，請添加一條規則以檢查`CI_HAS_OPEN_REQUIREMENTS` CI 變量. ``` requirements_confirmation: rules: - if: "$CI_HAS_OPEN_REQUIREMENTS" == "true" when: manual - when: never allow_failure: false script: - mkdir tmp - echo "{\"*\":\"passed\"}" > tmp/requirements.json artifacts: reports: requirements: tmp/requirements.json ```