Versioning: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
<big>To ensure that permanent URLs to an attachment for a specification is readable and permanent follow the best practices listed below. | <big>To ensure that permanent URLs to an attachment for a specification is readable and permanent follow the best practices listed below. | ||
</big> | </big> | ||
== Use Tags | == Use Tags! == | ||
Once the final version of the file is uploaded to the repository (see [[How to add files | here how to do it]]), you want to create a GIT Tag with the correct version (e.g. the version of the ETSI Deliverable). | Once the final version of the file is uploaded to the repository (see [[How to add files | here how to do it]]), you want to create a GIT Tag with the correct version (e.g. the version of the ETSI Deliverable). | ||
Line 9: | Line 7: | ||
To do so, follow the steps: | To do so, follow the steps: | ||
# Go to the repository | # Go to the repository | ||
# In the menu on the left, select <code>Repository</code> | # In the menu on the left, select <code>Repository</code> then <code>Tags</code> | ||
# Click on the Create Tag green button | |||
# Fill in the following information | |||
## Tag name: the version in a short version, e.g. v2.1.1 | |||
## Create from: Choose the correct branch or revision! (IMPORTANT) | |||
## Message: You may add a description of the version | |||
## Release note: Optional | |||
== Pretty view vs Raw view == | |||
== Do not encode versioning in the files == | == Do not encode versioning in the files == |
Revision as of 03:36, 22 February 2019
To ensure that permanent URLs to an attachment for a specification is readable and permanent follow the best practices listed below.
Use Tags![edit | edit source]
Once the final version of the file is uploaded to the repository (see here how to do it), you want to create a GIT Tag with the correct version (e.g. the version of the ETSI Deliverable).
To do so, follow the steps:
- Go to the repository
- In the menu on the left, select
Repository
thenTags
- Click on the Create Tag green button
- Fill in the following information
- Tag name: the version in a short version, e.g. v2.1.1
- Create from: Choose the correct branch or revision! (IMPORTANT)
- Message: You may add a description of the version
- Release note: Optional
Pretty view vs Raw view[edit | edit source]
Do not encode versioning in the files[edit | edit source]
Do not hard code the version in the file name, e.g. DO NOT:
my_file_v2.1.1.json
instead use
my_file.json
and let the GIT system manage and provide the licensing information.
In the same way, it is very bad practice to keep a list of folders such as (example based on fictitious ASN.1 modules for TB XYZ):
TB_XYZ_ASN.1_modules_v1 TB_XYZ_ASN.1_modules_v2 TB_XYZ_ASN.1_modules_v3 TB_XYZ_ASN.1_modules_v4 etc.