Versioning - Revision history

Carignani at 15:17, 23 January 2020

2020-01-23T15:17:54Z

← Older revision		Revision as of 17:17, 23 January 2020
Line 2:		Line 2:
	</big>		</big>

	<big>Please refer to the official guidelines at https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/editHelp%20Guidelines%20on%20Forge.pdf</big>		<div style="text-align:center;border: 2px solid red;">
			<big>'''Please refer to the official guidelines at '''
			https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/editHelp%20Guidelines%20on%20Forge.pdf</big>
			</div>
	== In brief ==		== In brief ==

Carignani at 15:16, 23 January 2020

2020-01-23T15:16:45Z

← Older revision		Revision as of 17:16, 23 January 2020
Line 1:		Line 1:
	<big>To ensure that permanent URLs to an attachment for a specification are '''readable''' and '''permanent''' follow the best practices listed below.		<big>To ensure that permanent URLs to an attachment for a specification are '''readable''' and '''permanent''' follow the best practices listed below.
	</big>		</big>

			<big>Please refer to the official guidelines at https://portal.etsi.org/Portals/0/TBpages/edithelp/Docs/editHelp%20Guidelines%20on%20Forge.pdf</big>

	== In brief ==		== In brief ==

Carignani at 10:51, 8 March 2019

2019-03-08T10:51:32Z

← Older revision		Revision as of 12:51, 8 March 2019
Line 55:		Line 55:
	To do so, simply visit the tags page in your project/repository (e.g. <code>forge.etsi.org/rep/<GROUP>/<REPO>/tags</code> ) by clicking on the Repository menu item.		To do so, simply visit the tags page in your project/repository (e.g. <code>forge.etsi.org/rep/<GROUP>/<REPO>/tags</code> ) by clicking on the Repository menu item.

	~~To do so~~, follow the steps:		In details, follow the steps:
	# Go to the repository		# Go to the repository
	# In the menu on the left, select <code>Repository</code> then <code>Tags</code>		# In the menu on the left, select <code>Repository</code> then <code>Tags</code>
	# Click on the Create Tag green button		# Click on the Create Tag green button
	# Fill in the following information		# Fill in the following information
	## Tag name: the version in a short version, e.g. v2.1.1		## Tag name: the version in a short version, e.g. v2.1.1 or TS-XYZ-ABC-v1.1.1
	## Create from: ~~Choose~~ the correct branch or revision~~! (IMPORTANT)~~		## Create from: Select the correct branch or a specific revision number. Please take extra care in this selection.
	## Message: You ~~may~~ add a description of the version		## Message: You should add a description of the version.
	## Release ~~note~~: Optional		## Release notes: (Optional) In case you want to provide the complete change log.

	== Pretty view vs Raw view ==		== Pretty view vs Raw view ==

Carignani at 10:47, 8 March 2019

2019-03-08T10:47:14Z

← Older revision		Revision as of 12:47, 8 March 2019
Line 51:		Line 51:
	== 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 interim or final version of the work is accomplished and uploaded to the repository (see [[How to add files \| here how to do it]]), you should '''create a GIT Tag''' with the correct version (e.g. the version of the ETSI Deliverable).

			To do so, simply visit the tags page in your project/repository (e.g. <code>forge.etsi.org/rep/<GROUP>/<REPO>/tags</code> ) by clicking on the Repository menu item.

	To do so, follow the steps:		To do so, follow the steps:

Carignani at 10:43, 8 March 2019

2019-03-08T10:43:06Z

← Older revision		Revision as of 12:43, 8 March 2019
Line 13:		Line 13:
	\|<code>forge.etsi.org/rep/<TB>/<SPEC>/</code>		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/</code>
	\|-		\|-
	\|For a specific version (where <~~version~~> is a ~~tag~~)		\|For a specific version (where <VERSION> is a TAG)
	\|<code>forge.etsi.org/rep/<TB>/<SPEC>/tree/<VERSION></code>		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/tree/<VERSION></code>
	\|-		\|-
	\|For a folder within the project		\|For a folder within the project
	\|<code>forge.etsi.org/rep/<TB>/<SPEC>/tree/<VERSION>/<~~FILE~~></code>		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/tree/<VERSION>/<FOLDER-PATH></code>
	\|-		\|-
	\|For a file in the mode		\|For a file in the mode
	\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/<VERSION>/<FILE></code>		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/<VERSION>/<FOLDER-PATH>/<FILE></code>
	\|}		\|}

Line 41:		Line 41:
	== Tool independent link ==		== Tool independent link ==

	Remember to use the tool independent link: <code>forge.etsi.org/rep</code>		Remember to use the tool independent link:

			<code>forge.etsi.org/rep/...</code>

			instead of

			<code>forge.etsi.org/gitlab/...</code>

	== Use Tags! ==		== Use Tags! ==

Carignani at 10:41, 8 March 2019

2019-03-08T10:41:07Z

← Older revision		Revision as of 12:41, 8 March 2019
Line 11:		Line 11:
	\|-		\|-
	\|For the entire project		\|For the entire project
	\|<code>forge.etsi.org/rep/<TB>/<SPEC>/<VERSION></code>		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/</code>
			\|-
			\|For a specific version (where <version> is a tag)
			\|<code>forge.etsi.org/rep/<TB>/<SPEC>/tree/<VERSION></code>
	\|-		\|-
	\|For a folder within the project		\|For a folder within the project
Line 26:		Line 29:
	!Example		!Example
	\|-		\|-
	\|~~Do not include~~ the tool (Gitlab) in the tool		\|Including the tool (Gitlab) in the tool
	\|<code>forge.etsi.org/gitlab/...</code>		\|<code>forge.etsi.org/gitlab/...</code>
	\|-		\|-
	\|~~Do not include~~ the version in the name of the file		\|Including the version in the name of the file
	\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/<BRANCH>/my_file_vA.B.C.txt</code>		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/<BRANCH>/my_file_vA.B.C.txt</code>
	\|-		\|-
	\|~~Avoid using~~ a link to master unless you know what you are doing		\|Using a link containing the word ''master'' (unless you know what you are doing)
	\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/master/...</code>		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/master/...</code>
	\|}		\|}

Carignani at 03:52, 22 February 2019

2019-02-22T03:52:32Z

← Older revision		Revision as of 05:52, 22 February 2019
Line 10:		Line 10:
	!Example		!Example
	\|-		\|-
	\|		\|For the entire project
	\|		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/<VERSION></code>
	\|-		\|-
	\|		\|For a folder within the project
	\|		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/tree/<VERSION>/<FILE></code>
	\|-		\|-
	\|		\|For a file in the mode
	\|		\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/<VERSION>/<FILE></code>
	\|}		\|}
	* For the entire project
	~~forge.etsi.org/rep/<TB>/<SPEC>/<VERSION>~~

	* For a folder within the project
	~~forge.etsi.org/rep/<TB>/<SPEC>/tree/<VERSION>/<FILE>~~

	* For a file in the mode
	~~forge.etsi.org/rep/<TB>/<SPEC>/blob/<VERSION>/<FILE>~~

	BAD examples:		BAD examples:

	* Do not include the tool (~~gitlab~~) in the tool		{\| class="wikitable"
	forge.etsi.org/gitlab/...		!Bad practice
			!Example
	* Do not include the version in the name of the file:		\|-
	forge.etsi.org/rep/<TB>/<SPEC>/blob/<BRANCH>/my_file_vA.B.C.txt		\|Do not include the tool (Gitlab) in the tool
			\|<code>forge.etsi.org/gitlab/...</code>
	* Avoid using a link to master unless you know what you are doing:		\|-
	forge.etsi.org/rep/<TB>/<SPEC>/blob/master/...		\|Do not include the version in the name of the file
			\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/<BRANCH>/my_file_vA.B.C.txt</code>
			\|-
			\|Avoid using a link to master unless you know what you are doing
			\|<code>forge.etsi.org/rep/<TB>/<SPEC>/blob/master/...</code>
			\|}

	== Tool independent link ==		== Tool independent link ==

	Remember to use the link ~~in the form~~		Remember to use the tool independent link: <code>forge.etsi.org/rep</code>

	== Use Tags! ==		== Use Tags! ==

Carignani at 03:46, 22 February 2019

2019-02-22T03:46:34Z

@@ Line 6: / Line 6: @@
 GOOD examples:
 * For the entire project
      forge.etsi.org/rep/<TB>/<SPEC>/<VERSION>

Carignani at 03:45, 22 February 2019

2019-02-22T03:45:37Z

@@ Line 1: / Line 1: @@
 <big>To ensure that permanent URLs to an attachment for a specification are '''readable''' and '''permanent''' follow the best practices listed below.
 </big>
 == Use Tags! ==

Carignani at 02:06, 22 February 2019

2019-02-22T02:06:04Z

← Older revision		Revision as of 04:06, 22 February 2019
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 are '''readable''' and '''permanent''' follow the best practices listed below.
	</big>		</big>
	== Use Tags! ==		== Use Tags! ==