How to develop with Git - Revision history

Josef templ: /* Building Stable Releases */

2017-12-12T10:37:11Z

Building Stable Releases

← Older revision		Revision as of 10:37, 12 December 2017
Line 90:		Line 90:
	For a final release ''X'', a tag named ''vX'' should be inserted into the Git repository.		For a final release ''X'', a tag named ''vX'' should be inserted into the Git repository.
	In GitHub, a tag is added by creating a so-called ''release''. The tag should be targeted at the ''master'' branch.		In GitHub, a tag is added by creating a so-called ''release''. The tag should be targeted at the ''master'' branch.
	The tag name ''vX'' is also used as the ''release title''. Download links ~~may~~ be added in the description.		The tag name ''vX'' is also used as the ''release title''. Download links should be added in the description.
			By creating a release, Github creates source code archives in two formats (zip and tar.gz) automatically.

	Finally, the download page of the center's web site should be updated.		Finally, the download page of the center's web site should be updated.

Josef templ: /* Building Stable Releases */

2017-12-11T14:12:05Z

Building Stable Releases

← Older revision		Revision as of 14:12, 11 December 2017
Line 78:		Line 78:

	== Building Stable Releases ==		== Building Stable Releases ==
	If the build engine detects an AppVersion.txt file with no development stage postfix, it builds a stable (final) release automatically.		Before building a stable release, check the state of all issues belonging to that release in the ''redmine'' issue tracker.
			Also check if descriptions of the issues exist and if they are formatted appropriately.
			They should look well both in html and in the BlackBox changelist document.

			If the build engine builds for the branch ''master'' and detects an ''AppVersion.txt'' file with no development stage postfix, it builds a stable (final) release automatically.
			The core of building a stable release therefore is to remove the development stage postfix from the file ''appbuild/AppVersion.txt'' and commit it to ''master''.

	The output of the build process will be available in [http://blackboxframework.org/stable/ http://blackboxframework.org/stable].		The output of the build process will be available in [http://blackboxframework.org/stable/ http://blackboxframework.org/stable].
	The build output is supposed to be never changed later on without setting a new version number in AppVersion.txt.		The build output is supposed to be never changed later on without setting a new version number in ''AppVersion.txt''.

	For a final release ''X'', a tag named ''vX'' should be inserted into the Git repository.		For a final release ''X'', a tag named ''vX'' should be inserted into the Git repository.
	In GitHub, a tag is added by creating a so-called ''release''. The tag should be targeted at the master branch,		In GitHub, a tag is added by creating a so-called ''release''. The tag should be targeted at the ''master'' branch.
	~~which~~ is used ~~for creating final releases~~.		The tag name ''vX'' is also used as the ''release title''. Download links may be added in the description.

	Finally, the download page of the center's web site should be updated.		Finally, the download page of the center's web site should be updated.

Josef templ: /* Building Stable Releases */

2017-12-11T13:25:02Z

Building Stable Releases

← Older revision		Revision as of 13:25, 11 December 2017
Line 83:		Line 83:
	The build output is supposed to be never changed later on without setting a new version number in AppVersion.txt.		The build output is supposed to be never changed later on without setting a new version number in AppVersion.txt.

	For a final release X.Y, a tag named vX.Y should be inserted into the Git repository.		For a final release ''X'', a tag named ''vX'' should be inserted into the Git repository.
	In GitHub, a tag is added by creating a so-called release. The tag should be targeted at the master branch,		In GitHub, a tag is added by creating a so-called ''release''. The tag should be targeted at the master branch,
	which is used for creating final releases.		which is used for creating final releases.

			Finally, the download page of the center's web site should be updated.

	== Notes on Naming ==		== Notes on Naming ==

Josef templ: /* Related Pages */

2017-12-11T09:03:04Z

← Older revision		Revision as of 09:03, 11 December 2017
Line 1:		Line 1:
	== Related Pages ==		== Related Pages ==

	Pages related to this topic are [[Git]] and [[How to develop with Tortoise Git]].		Pages related to this topic are [[BlackBox Versioning Strategy\|The BlackBox Versioning Strategy]], [[Git]] and [[How to develop with Tortoise Git]].

	== Topic Branches ==		== Topic Branches ==

Robert: /* Topic Branches */

2017-03-30T20:13:29Z

Topic Branches

← Older revision		Revision as of 20:13, 30 March 2017
Line 7:		Line 7:
	we create a branch from 'master' in our [https://github.com/BlackBoxCenter/blackbox GitHub repository].		we create a branch from 'master' in our [https://github.com/BlackBoxCenter/blackbox GitHub repository].

	A new branch is created by ~~entering~~ the new branch ~~name~~		A new branch is created by:
	~~into~~ the "Find or create branch~~...~~" ~~text box of~~ the '~~Branch:~~ master' ~~drop down menu~~. If you use your browser's search function to search for the drop-down menu, use the search string 'Branch:', i.e. without 'master' because this depends on the currently selected branch.
	~~At the bottom of the drop down menu a menu item is offered for creating the new branch ([[Media:Makebranch.png]]) after entering a new branch name in the text box~~.		* Go to GitHub https://github.com/BlackBoxCenter/blackbox.
			* Alternatively:
			*# Go to the Center page: https://forum.blackboxframework.org.
			*# Click on the top level yellow option "GitHub repository"
			*# Click on the large blue "blackbox" text in the center of the page.

			* Use the drop-down on the left of the page "Branch: master ▼" to create the new branch.
			*# In the field with light grey text "Find or create a branch" type "issue-#N"
			*# Click in the blue area "Create branch: issue-#N from 'master'".

			If you use your browser's search function to search for the drop-down menu, use the search string 'Branch:', i.e. without 'master' because this depends on the currently selected branch.

	If an issue has number N, we name that newly created branch		If an issue has number N, we name that newly created branch

Robert at 20:14, 2 November 2016

2016-11-02T20:14:24Z

← Older revision		Revision as of 20:14, 2 November 2016
Line 1:		Line 1:
			== Related Pages ==

			Pages related to this topic are [[Git]] and [[How to develop with Tortoise Git]].

	== Topic Branches ==		== Topic Branches ==
	For every issue entered into the redmine issue tracker		For every issue entered into the redmine issue tracker

Josef templ: /* Topic Branches */

2016-11-02T12:27:25Z

Topic Branches

← Older revision		Revision as of 12:27, 2 November 2016
Line 4:		Line 4:

	A new branch is created by entering the new branch name		A new branch is created by entering the new branch name
	into the "Find or create branch..." text box of the 'Branch: master' drop down menu.		into the "Find or create branch..." text box of the 'Branch: master' drop down menu. If you use your browser's search function to search for the drop-down menu, use the search string 'Branch:', i.e. without 'master' because this depends on the currently selected branch.
	At the bottom of the drop down menu a menu item is offered for creating the new branch ([[Media:Makebranch.png]]) after entering a new branch name in the text box.		At the bottom of the drop down menu a menu item is offered for creating the new branch ([[Media:Makebranch.png]]) after entering a new branch name in the text box.

Josef templ: /* Topic Branches */

2016-11-02T12:24:12Z

Topic Branches

← Older revision		Revision as of 12:24, 2 November 2016
Line 4:		Line 4:

	A new branch is created by entering the new branch name		A new branch is created by entering the new branch name
	into the "Find or create branch..." box of the '~~branch~~' drop down menu ~~right to the green button~~.		into the "Find or create branch..." text box of the 'Branch: master' drop down menu.
	At the bottom of the drop down menu a menu item is offered for creating the new branch ([[Media:Makebranch.png]]).		At the bottom of the drop down menu a menu item is offered for creating the new branch ([[Media:Makebranch.png]]) after entering a new branch name in the text box.

	If an issue has number N, we name that newly created branch		If an issue has number N, we name that newly created branch

Josef templ: /* Notes on Learning Git */

2016-10-27T09:15:48Z

Notes on Learning Git

← Older revision		Revision as of 09:15, 27 October 2016
Line 93:		Line 93:
	can only be mastered if the basics of Git are clear.		can only be mastered if the basics of Git are clear.

	The starting point for working with Git is the clone command.		The starting point for working with Git from the command line is the clone command.
	If you want to work on issue <N>, use the following command for cloning		If you want to work on issue <N>, use the following command for cloning
	the repository to your local machine.		the repository to your local machine.
Line 101:		Line 101:
	This command will create a new directory named blackbox-<N> with a clone of the repository.		This command will create a new directory named blackbox-<N> with a clone of the repository.
	Option -b sets the current branch to issue-#<N>.		Option -b sets the current branch to issue-#<N>.

			The starting point for working with Git with the GUI-based tool Tortoise Git is [[How to develop with Tortoise Git]].

Josef templ: /* Bi-Directional Traceability */

2016-08-16T09:35:54Z

Bi-Directional Traceability

← Older revision		Revision as of 09:35, 16 August 2016
Line 30:		Line 30:

	== Bi-Directional Traceability ==		== Bi-Directional Traceability ==
	The general rule with respect to committing changes to [[Git]] is to always refer to an issue in the commit message.		The general rule with respect to committing changes to [[Git]] is to always refer to an issue in the first line of the commit message.

	The format of the first line of a commit message that refers to issue number N is		The format of the first line of a commit message that refers to issue number N is

	<code><commit message text>. Refs: #N.</code>		<code><commit message text>. Refs: #N.</code>

			Example commit message for issue-#121:
			<pre>
			fix for a compiler warning regarding unreleased register AX. Refs: #121.
			As proposed by luowy but slightly corrected.
			The additional FreeHi must only be called when y.mode = Int64.
			</pre>

	When browsing the source code repository or when looking at commits (alias revisions) in redmine, references to issues will show up as links that can be clicked on.		When browsing the source code repository or when looking at commits (alias revisions) in redmine, references to issues will show up as links that can be clicked on.