@@ -33,35 +33,46 @@ Annex 6, definition number 14.
The steps below describe the process for contribution and integration of software hosted on ETSI Forge repository.
1. (Optional) Contributor reserves a contribution number on the ETSI Portal
2. Contributor creates and submits a merge request in the appropriate project on ETSI Forge
a. The submitted Merge Request shall include:
i. The changes uploaded to a branch in the repository with a given temporary name (the branch will be deleted after the merge),
ii. Motivation, rationale or purpose of the changes, and
iii. the description of changes;
b. It may also include:
i. a contribution number (if any),
ii. Link to a Bugzilla issue or Gitlab issue.
3. Contributor prepares and makes available a contribution on the Portal.
a. The submitted contribution shall include:
i. Link to the Merge Request
ii. Reference in the text to the location of the changed software, i.e. the changes in the target deliverable which include the links to the new version of the software in the named branch linked to the MR
• EXAMPLE: Merge request XYZ proposes to merge branch FEAT1 into branch v1.1.x and is to be approved in contribution (19)00000ABC. The contribution will contain the changes in the base deliverable with the URLs updated to point to forge.etsi.org/rep/TB/DOCNUM/tree/FEAT1
### 1. (Optional) Contributor reserves a contribution number on the ETSI Portal
### 2. Contributor creates and submits a merge request in the appropriate project on ETSI Forge
- The submitted Merge Request shall include:
- The changes uploaded to a branch in the repository with a given temporary name (the branch will be deleted after the merge),
- Motivation, rationale or purpose of the changes, and the description of changes;
- It may also include:
- a contribution number (if any),
- a link to a Bugzilla issue or Gitlab issue.
### 3. Contributor prepares and makes available a contribution on the Portal.
- The submitted contribution shall include:
- Link to the Merge Request
- Reference in the text to the location of the changed software, i.e. the changes in the target deliverable which include the links to the new version of the software in the named branch linked to the MR
EXAMPLE: Merge request XYZ proposes to merge branch FEAT1 into branch v1.1.x and is to be approved in contribution (19)00000ABC. The contribution will contain the changes in the base deliverable with the URLs updated to point to forge.etsi.org/rep/TB/DOCNUM/tree/FEAT1
b. It may include
i. The tag to be applied after the MR is merged
ii. Changes to other elements of the deliverable (e.g. textual descriptions, tables, figures, etc.) required to maintain consistency with the changes proposed in the Merge Request.
4. Contribution approval process is held leading to the approval of the contribution on the Portal;
### 4. Contribution approval process is held leading to the approval of the contribution on the Portal;
a. If the proposed changes need revisions – either due to email discussion , or discussion during a meeting – the software on the Forge will be changed first (generating a new version) and the related contribution needs to be revised to include the pointer to the latest changes.
5. The rapporteur merges the Merge request(s?) related to the approved contributions.
### 5. The rapporteur merges the Merge request(s?) related to the approved contributions.
a. NOTE: this activity may be automatized in the future but needs to take into the account the possibility of conflicts thus requiring manual intervention.
6. Rapporteur applies the appropriate tag to the repository
### 6. Rapporteur applies the appropriate tag to the repository
a. With the version number of the Draft deliverable that will reference the tag
b. Note: This may be automatized
7. Rapporteur updates the draft of the deliverable
### 7. Rapporteur updates the draft of the deliverable
a. All temporary links replaced with the link to the tagged version;
b. The other elements in the approved contributions are incorporated as well, as usual.
8. ETSI Secretariat receives the final draft ready for publication;
9. ETSI Secretariat finalizes the repository, applies the publication tag and finalizes the document.
### 8. ETSI Secretariat receives the final draft ready for publication;
### 9. ETSI Secretariat finalizes the repository, applies the publication tag and finalizes the document.
## Templates of a contribution for software
@@ -69,18 +80,16 @@ The high-level content required or optional in a merge request and the related c
### Merge request
Id Field Provision Description
M01 Unique URL Mandatory E.g. <forge>/<my-group>/<my-project>/merge_requests/<ID>
M02 Diff: Changes in the software
Mandatory
M03 Motivation, rationale or purpose of the changes
M04 Description of the changes Mandatory
M05 Green light from CI Validation Mandatory
M06 Software URL (where ‘my-title’ is a branch): Mandatory E.g. <forge>/<my-group>/<my-repo>/0.0.x
M07 Reserved contribution number in the Merge request documentation Optional
M08 Link to Bugzilla or Gitlab issue Optional
| Id | Field | Provision | Description |
| ---| ----- | ------- | -----------:|
|M01 | Unique URL | Mandatory | E.g. <forge>/<my-group>/<my-project>/merge_requests/<ID> |
|M02 | Diff : Changes in the software | Mandatory | |
|M03 | Motivation, rationale or purpose of the changes | |
|M04 | Description of the changes | Mandatory | |
|M05 | Green light from CI Validation | Mandatory | |
|M06 | Software URL | Mandatory | E.g. <forge>/<my-group>/<my-repo>/0.0.x |
|M07 | Reserved contribution number in the Merge request documentation | Optional | |
|M08 | Link to Bugzilla or Gitlab issue | Optional | |
