GitLab best practice - Revision history

Mri083: /* Commit strategy */

2021-03-04T16:20:51Z

Commit strategy

@@ Line 133: / Line 133: @@
 *'''Atomicity:''' A commit should include all changes which belong together, e.g. to compile a new executable. Atomicity must be followed when commits are finally prepared for merging to master repository. Every commit in the master repository must represent a compilable snapshot
 *'''Separation:''' Separate changes not belonging together and not necessary for an atomic commit. E.g. do pure formatting changes separated from functional changes.
 == Handling merge requests ==

Mri083: /* Synchronizing developer fork with main repository */ Updating the information on repository mirroring

2021-03-04T16:10:42Z

Synchronizing developer fork with main repository: Updating the information on repository mirroring

← Older revision		Revision as of 16:10, 4 March 2021
Line 66:		Line 66:
	'''This should be done regularly!'''		'''This should be done regularly!'''

	~~There is unfortunately no simple synchronization feature~~ for ~~forks within Gitlab (from Gitlab Enterprise Edition 8~~.2 ''repository ~~mirroring~~'' ~~is provided)~~. ~~Synchronization~~ is done in a local clone or via merge ~~reqursts~~.		Gitlab in general provides ''repository mirroring'' for synchronizing different repositories. Mirroring can be done by either ''Push'' or ''Pull''. The GitLab version hosted at UiB provides only the option to ''Push'' and mirroring can only be set up in the master repository to ''push'' updates a fork. If ''Pull'' was available, each user would be able to setup mirroring. If you want this for your fork, get in contact with the [[Documentation#Mailing lists and collaborative tools \| administrators]]. More information can be found in [[Gitlab Master FAQ#Mirror a repository]].

			Otherwise, synchronization is done in a local clone or via merge requests as described below.

	In fact, the matter is not so easy in itself as there can be conflicting developments in the master repository and your development fork.		In fact, the matter is not so easy in itself as there can be conflicting developments in the master repository and your development fork.

Mri083: /* Create developer fork */ Adding note on using the common developer fork

2021-03-04T15:57:16Z

Create developer fork: Adding note on using the common developer fork

← Older revision		Revision as of 15:57, 4 March 2021
Line 58:		Line 58:

	'''Note:''' If the master repository is not public, also your fork won't be public and you have to allow your colleagues to access it, see in the rules above.		'''Note:''' If the master repository is not public, also your fork won't be public and you have to allow your colleagues to access it, see in the rules above.

			If your account type does not allow for your personal namespace, you can use the common developer fork, see [[GitLab Developer FAQ#My external user account on GitLab does not give me a namespace for forking]].

			If you are a very active developer, the common developer fork might not be the right place and we can set up a specific subgroup for you to provide a namespace. Get in contact with the [[Documentation#Mailing lists and collaborative tools \| administrators]].

	=== Synchronizing developer fork with main repository ===		=== Synchronizing developer fork with main repository ===

Mri083: /* Git commits */

2021-02-23T12:40:33Z

Git commits

@@ Line 99: / Line 99: @@
 == Git commits ==
 === Log message format ===
 == Handling merge requests ==

Mri083: /* Update fork using merge request */

2021-02-23T11:37:37Z

Update fork using merge request

Mri083: /* The developer fork */

2021-02-23T08:01:37Z

The developer fork

← Older revision		Revision as of 08:01, 23 February 2021
Line 50:		Line 50:

	== The developer fork ==		== The developer fork ==
	The ''developer fork'' is the main feature in ~~Gitlabs~~/~~Githubs~~ concept of distributed development, code sharing and code review.		The ''developer fork'' is the main feature in Gitlab's/Github's concept of distributed development, code sharing and code review.

	=== Create developer fork ===		=== Create developer fork ===

Mri083: /* Terminology */

2021-02-23T08:00:14Z

Terminology

← Older revision		Revision as of 08:00, 23 February 2021
Line 21:		Line 21:
	* '''merge''': two branches are brought together and the result commited with a new commit		* '''merge''': two branches are brought together and the result commited with a new commit
	* '''rebase''': the history of a branch is applied to another branch resulting into a new history containing the commits of both branches		* '''rebase''': the history of a branch is applied to another branch resulting into a new history containing the commits of both branches
	* '''fork''': repository copy in a user space of GitLab ~~server system~~		* '''fork''': repository copy in a user space of GitLab service
	* '''clone''': local working copy on a machine		* '''clone''': local working copy on a machine

Mri083: /* Roles */

2021-02-23T07:55:52Z

Roles

← Older revision		Revision as of 07:55, 23 February 2021
Line 39:		Line 39:
	# '''Developer role''': A ''developer'' contributes to the development.		# '''Developer role''': A ''developer'' contributes to the development.

	~~From~~ the GitLab web interface [https://git.app.uib.no/pct/pct-online pct-online], ~~an archive can be downloaded~~ by clicking the download symbol like in this screen shot.		As a '''User''', you can download an archive from the GitLab web interface, e. g. [https://git.app.uib.no/pct/pct-online pct-online], by clicking the download symbol like in this screen shot.

	[[File:Pct-online-download-button.png]]		[[File:Pct-online-download-button.png]]

Mri083: /* Update fork using merge request */ Adding an illustration

2021-02-22T16:15:20Z

Update fork using merge request: Adding an illustration

← Older revision		Revision as of 16:15, 22 February 2021
Line 88:		Line 88:
	# Select the <code>dev</code> branch of the master repository as source		# Select the <code>dev</code> branch of the master repository as source
	# Select your developer fork as target and choose branch to be updated		# Select your developer fork as target and choose branch to be updated
	# Press <span style="color:white; background:green; border:solid 2px green">'''Compare and continue'''</span>		#:[[File:Git-fork-update-by-merge-request.png]]
			# Press <span style="color:white; background:green; border:solid 2px green">'''Compare branches and continue'''</span>
	# Set a title, e.g. "Updating dev branch from master repository", check once again that the source is the master repository and the target your developer fork		# Set a title, e.g. "Updating dev branch from master repository", check once again that the source is the master repository and the target your developer fork
	# Take the occasion to check what has happened since your last update and scroll through the new commits		# Take the occasion to check what has happened since your last update and scroll through the new commits

Mri083: /* The developer fork */ Clarifying recipe to update fork

2021-02-22T16:02:10Z

The developer fork: Clarifying recipe to update fork

@@ Line 51: / Line 51: @@
 == The developer fork ==
 The ''developer fork'' is the main feature in Gitlabs/Githubs concept of distributed development, code sharing and code review.
 === Synchronizing developer fork with main repository ===
 '''This should be done regularly!'''
-There is unfortunately no simple synchronization feature for forks within Gitlab (from Gitlab Enterprise Edition 8.2 ''repository mirroring'' is provided). Synchronization is done in the local clone.
+There is unfortunately no simple synchronization feature for forks within Gitlab (from Gitlab Enterprise Edition 8.2 ''repository mirroring'' is provided). Synchronization is done in a local clone or via merge reqursts.
 # Fetch branch from the master repository
-#:<pre> git fetch https://gitlab.uib.no/pct/wpn.git dev</pre>
+#:<pre> git fetch git@git.app.uib.no:pct/pct-online.git dev</pre>
 # Rebase local branch
 #:<pre> git rebase FETCH_HEAD dev</pre>
 # Push to fork
 #:<pre> git push origin dev</pre>
 == Git commits ==

← Older revision		Revision as of 11:37, 23 February 2021
Line 84:		Line 84:
	'''Note:''' we only want fast-forward merges in this case, this can not be done if the source branch is not a direct continuation of the target branch, i.e. new commits are present. Do the rebase in the local clone in such a case.this case.		'''Note:''' we only want fast-forward merges in this case, this can not be done if the source branch is not a direct continuation of the target branch, i.e. new commits are present. Do the rebase in the local clone in such a case.this case.
	# Open the GitLab web interface for the repository		# Open the GitLab web interface for the repository
	# In the tool bar at the top click <span style="color:blue; background:while; border:solid 2px blue">'''+'''</span> and '''New merge request''' in the drop-down menu		# In the tool bar at the top click <span style="color:blue; background:blue; border:solid 2px blue">.</span><span style="color:blue; background:while; border:solid 2px blue">'''+'''</span><span style="color:blue; background:blue; border:solid 2px blue">.</span> and '''New merge request''' in the drop-down menu
	#:Note: you can not go via <code>Merge Requests</code> -> <code>Create merge request</code> because this will redirect to your developer fork and you can not select the master repository as source from there.		#:Note: you can not go via <code>Merge Requests</code> -> <code>Create merge request</code> because this will redirect to your developer fork and you can not select the master repository as source from there.
	# Select the <code>dev</code> branch of the master repository as source		# Select the <code>dev</code> branch of the master repository as source
	# Select your developer fork as target and choose branch to be updated		# Select your developer fork as target and choose branch to be updated
	#:[[File:Git-fork-update-by-merge-request.png]]		#::[[File:Git-fork-update-by-merge-request.png]]
	# Press <span style="color:white; background:green; border:solid 2px green">'''Compare branches and continue'''</span>		# Press <span style="color:white; background:green; border:solid 2px green">'''Compare branches and continue'''</span>
	# Set a title, e.g. "Updating dev branch from master repository", check once again that the source is the master repository and the target your developer fork		# Set a title, e.g. "Updating dev branch from master repository", check once again that the source is the master repository and the target your developer fork
Line 96:		Line 96:
	# Once the CI succeeds, merge '''by fast-forward''' - Important '''DO NOT MERGE BY CREATING MERGE COMMITS!'''		# Once the CI succeeds, merge '''by fast-forward''' - Important '''DO NOT MERGE BY CREATING MERGE COMMITS!'''

	If the option to merge by fast-forward is not displayed, this needs to be changed in the project settings of the developer fork.		If the option to merge by fast-forward is not displayed, this needs to be changed in the project settings of the developer fork, see [[GitLab Developer FAQ#Select Fast-forward merge]]

	== Git commits ==		== Git commits ==