Guide to Changelogs - Revision history

Sergeirocks100: 23 revisions imported

2022-01-19T16:35:20Z

23 revisions imported

← Older revision

Revision as of 16:35, 19 January 2022

tgstation>SpaceManiac: Remove "Game Resources" category

2020-12-04T03:40:20Z

Remove "Game Resources" category

← Older revision		Revision as of 03:40, 4 December 2020
Line 83:		Line 83:

	{{Contribution guides}}		{{Contribution guides}}
	~~[[Category:Guides]] [[Category:Game Resources]]~~

tgstation>SpaceManiac: Remove extra indentation from code blocks

2020-11-30T07:19:03Z

Remove extra indentation from code blocks

← Older revision		Revision as of 07:19, 30 November 2020
Line 3:		Line 3:
	You can add changelog entries by using the following template in the body of your pull request:		You can add changelog entries by using the following template in the body of your pull request:

	:cl: ~~name~~		:cl:
	prefix: text		prefix: text
	prefix: text		prefix: text
	prefix: text		prefix: text
	/:cl:		/:cl:

	Your GitHub username is credited by default, or you can add a name at the end of the <tt>:cl:</tt> line to override it.		Your GitHub username is credited by default, or you can add a name at the end of the <tt>:cl:</tt> line to override it.
Line 58:		Line 58:

	'''File content example:'''		'''File content example:'''
	author: Deantwo		author: Deantwo

	delete-after: True		delete-after: True

	changes:		changes:
	- rscadd: "Added laser rifles for everyone."		- rscadd: "Added laser rifles for everyone."
	- rscdel: "Removed everyone's brains."		- rscdel: "Removed everyone's brains."

	=== Updating the Changelog ===		=== Updating the Changelog ===

tgstation>SpaceManiac at 04:08, 30 November 2020

2020-11-30T04:08:31Z

← Older revision		Revision as of 04:08, 30 November 2020
Line 1:		Line 1:
	~~{{note\|This guide thanks~~ to ~~friends from [http~~://~~ss13~~.~~nexisonline.net/wiki/Guide_to_Changelogs /vg/].}}~~		: [[Guide to contributing to the game]]

			You can add changelog entries by using the following template in the body of your pull request:

			:cl: name
			prefix: text
			prefix: text
			prefix: text
			/:cl:

			Your GitHub username is credited by default, or you can add a name at the end of the <tt>:cl:</tt> line to override it.

			Valid prefixes are:

	~~Changelogs are small YAML files that developers create to~~ add ~~their pull requests' changes to the master changelog~~.~~html file~~. ~~A python script run by a maintainer collects all the changes specified and generates the HTML necessary, merging changes by the same author during the same day~~.		* [[File:Tick-circle.png]] add
			* [[File:Cross-circle.png]] del
			* [[File:Bug-minus.png]] fix
			* [[File:Hard-hat-exclamation.png]] wip
			* [[File:Wrench-screwdriver.png]] tweak
			* [[File:Burn-exclamation.png]] experiment
			* [[File:Spell-check.png]] spellcheck
			* [[File:Music-plus.png]] soundadd
			* [[File:Music-minus.png]] sounddel
			* [[File:Image-plus.png]] imageadd
			* [[File:Image-minus.png]] imagedel
			* [[File:Scales_icon.png]] balance
			* [[File:Coding.png]] code
			* [[File:Burn-exclamation.png]] refactor
			* [[File:Chrome-wrench.gif]] config
			* [[File:Ban.png]] admin
			* [[File:Hard-hat-exclamation.png]] server

	~~On the /tg/station Github changelogs can be automatically generated from special formatting in the body of a PR's description.~~

	~~The idea is~~ to ~~reduce merge conflicts caused by two PRs trying to edit the same file~~.		== Advanced information ==
			{{note\|This guide thanks to friends from [http://ss13.nexisonline.net/wiki/Guide_to_Changelogs /vg/].}}

	~~== Creating~~ a ~~Changelog ==~~		Changelogs are small YAML files that developers create to add their pull requests' changes to the master changelog.html file. A python script run by a maintainer collects all the changes specified and generates the HTML necessary, merging changes by the same author during the same day.

	=== Online auto-creation ===		=== Online auto-creation ===
	~~By formatting text~~ in ~~the body of~~ your PR description ~~you can have~~ a ~~changelog~~ .yml file ~~automatically generated for you.~~		On the /tg/station GitHub, a formatted block in your PR's description as described above will cause a bot to automatically generate a <tt>.yml</tt> file.
	Declare the start of a changelog entry with :cl: and close it with /:cl:; anything in between these two tags will included, remember to use prefixes for each line. See below for a list of valid prefixes.
	~~An author can be set after the :cl: tag, if omitted your Github username will be used by default~~.

	~~'''Format example:'''~~		The idea is to reduce merge conflicts caused by two PRs trying to edit the same file.
	~~:cl: Deantwo~~
	~~rscadd: Added laser rifles for everyone~~.
	~~rscdel: Removed everyone's brains.~~
	~~/:cl:~~

	=== Committing a .yml file ===		=== Committing a .yml file ===
Line 46:		Line 68:
	=== Updating the Changelog ===		=== Updating the Changelog ===

	:''Only maintainers need to do this.''		''Only maintainers need to do this.''

	* First, install python3, pip, and PyYaml:		* First, install python3, pip, and PyYaml:
Line 56:		Line 78:
	* On Linux or other codebases, run <code>python tools/ss13_genchangelog.py html/changelog.html html/changelogs</code>		* On Linux or other codebases, run <code>python tools/ss13_genchangelog.py html/changelog.html html/changelogs</code>

	== Screwed up Changelog ==		=== Screwed up Changelog ===
	If a changelog needs to be edited after merge, a maintainer will need to edit the html/changelogs/.all_changelog.yml file in order to fix the database. (This file is hidden on Linux and Mac OSX.)		If a changelog needs to be edited after merge, a maintainer will need to edit the html/changelogs/.all_changelog.yml file in order to fix the database. (This file is hidden on Linux and Mac OSX.)

	~~== Valid Prefixes ==~~
	~~Any of these prefixes can be used when creating a changelog.~~
	*[[File:Bug-minus.png]] bugfix
	*[[File:Hard-hat-exclamation.png]] wip
	*[[File:Wrench-screwdriver.png]] tweak
	*[[File:Music-plus.png]] soundadd
	*[[File:Music-minus.png]] sounddel
	*[[File:Tick-circle.png]] rscadd
	*[[File:Cross-circle.png]] rscdel
	*[[File:Image-plus.png]] imageadd
	*[[File:Image-minus.png]] imagedel
	*[[File:Spell-check.png]] spellcheck
	*[[File:Burn-exclamation.png]] experiment

	{{Contribution guides}}		{{Contribution guides}}
	[[Category:Guides]] [[Category:Game Resources]]		[[Category:Guides]] [[Category:Game Resources]]

tgstation>Oranges: /* Updating the Changelog */

2018-04-05T22:00:25Z

Updating the Changelog

← Older revision		Revision as of 22:00, 5 April 2018
Line 48:		Line 48:
	:''Only maintainers need to do this.''		:''Only maintainers need to do this.''

	* First, install ~~python 2.7~~, pip, and PyYaml:		* First, install python3, pip, and PyYaml:
	** After installing python and ensuring it and its Scripts/ folder is in PATH, download and run [https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py get-pip.py] with python.		** After installing python and ensuring it and its Scripts/ folder is in PATH, download and run [https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py get-pip.py] with python.
	** Once pip is installed run the following commands in your terminal		** Once pip is installed run the following commands in your terminal

tgstation>Oranges: reorder for most likely case first

2016-12-14T08:54:28Z

reorder for most likely case first

← Older revision		Revision as of 08:54, 14 December 2016
Line 8:		Line 8:

	== Creating a Changelog ==		== Creating a Changelog ==

			=== Online auto-creation ===
			By formatting text in the body of your PR description you can have a changelog .yml file automatically generated for you.
			Declare the start of a changelog entry with :cl: and close it with /:cl:; anything in between these two tags will included, remember to use prefixes for each line. See below for a list of valid prefixes.
			An author can be set after the :cl: tag, if omitted your Github username will be used by default.

			'''Format example:'''
			:cl: Deantwo
			rscadd: Added laser rifles for everyone.
			rscdel: Removed everyone's brains.
			/:cl:

	=== Committing a .yml file ===		=== Committing a .yml file ===
Line 32:		Line 43:
	- rscadd: "Added laser rifles for everyone."		- rscadd: "Added laser rifles for everyone."
	- rscdel: "Removed everyone's brains."		- rscdel: "Removed everyone's brains."

	~~=== Online auto-creation ===~~
	~~By formatting text in the body of your PR description you can have a changelog .yml file automatically generated for you.~~
	Declare the start of a changelog entry with :cl: and close it with /:cl:; anything in between these two tags will included, remember to use prefixes for each line. See below for a list of valid prefixes.
	~~An author can be set after the :cl: tag, if omitted your Github username will be used by default.~~

	~~'''Format example:'''~~
	~~:cl: Deantwo~~
	~~rscadd: Added laser rifles for everyone.~~
	~~rscdel: Removed everyone's brains.~~
	~~/:cl:~~

	=== Updating the Changelog ===		=== Updating the Changelog ===

tgstation>MrStonedOne: /* Online auto-creation */

2015-11-25T03:36:54Z

Online auto-creation

← Older revision		Revision as of 03:36, 25 November 2015
Line 37:		Line 37:
	Declare the start of a changelog entry with :cl: and close it with /:cl:; anything in between these two tags will included, remember to use prefixes for each line. See below for a list of valid prefixes.		Declare the start of a changelog entry with :cl: and close it with /:cl:; anything in between these two tags will included, remember to use prefixes for each line. See below for a list of valid prefixes.
	An author can be set after the :cl: tag, if omitted your Github username will be used by default.		An author can be set after the :cl: tag, if omitted your Github username will be used by default.
	~~Don't use double quotation marks " " in your entry as they are used as delimiters by the changelog system which will break upon encountering them.~~

	'''Format example:'''		'''Format example:'''

tgstation>Jordie0608 at 04:41, 24 November 2015

2015-11-24T04:41:42Z

← Older revision		Revision as of 04:41, 24 November 2015
Line 2:		Line 2:

	Changelogs are small YAML files that developers create to add their pull requests' changes to the master changelog.html file. A python script run by a maintainer collects all the changes specified and generates the HTML necessary, merging changes by the same author during the same day.		Changelogs are small YAML files that developers create to add their pull requests' changes to the master changelog.html file. A python script run by a maintainer collects all the changes specified and generates the HTML necessary, merging changes by the same author during the same day.

			On the /tg/station Github changelogs can be automatically generated from special formatting in the body of a PR's description.

	The idea is to reduce merge conflicts caused by two PRs trying to edit the same file.		The idea is to reduce merge conflicts caused by two PRs trying to edit the same file.
Line 7:		Line 9:
	== Creating a Changelog ==		== Creating a Changelog ==

	=== ~~Pull Requests~~ ===		=== Committing a .yml file ===
	PR changelogs are temporary and just get deleted after they're merged into the master changelog.		PR changelogs are temporary and just get deleted after they're merged into the master changelog.

Line 31:		Line 33:
	- rscdel: "Removed everyone's brains."		- rscdel: "Removed everyone's brains."

	=== ~~Maintainer Changelogs~~ ===		=== Online auto-creation ===
	~~Maintainers~~ can have ~~their own changelogs~~. ~~Follow~~ the ~~same directions as above~~, ~~but~~ use ~~USERNAME~~.~~yml and leave delete-~~after ~~false~~.		By formatting text in the body of your PR description you can have a changelog .yml file automatically generated for you.
			Declare the start of a changelog entry with :cl: and close it with /:cl:; anything in between these two tags will included, remember to use prefixes for each line. See below for a list of valid prefixes.
			An author can be set after the :cl: tag, if omitted your Github username will be used by default.
			Don't use double quotation marks " " in your entry as they are used as delimiters by the changelog system which will break upon encountering them.

			'''Format example:'''
			:cl: Deantwo
			rscadd: Added laser rifles for everyone.
			rscdel: Removed everyone's brains.
			/:cl:

	=== Updating the Changelog ===		=== Updating the Changelog ===
Line 48:		Line 59:
	== Screwed up Changelog ==		== Screwed up Changelog ==
	If a changelog needs to be edited after merge, a maintainer will need to edit the html/changelogs/.all_changelog.yml file in order to fix the database. (This file is hidden on Linux and Mac OSX.)		If a changelog needs to be edited after merge, a maintainer will need to edit the html/changelogs/.all_changelog.yml file in order to fix the database. (This file is hidden on Linux and Mac OSX.)

			== Valid Prefixes ==
			Any of these prefixes can be used when creating a changelog.
			*[[File:Bug-minus.png]] bugfix
			*[[File:Hard-hat-exclamation.png]] wip
			*[[File:Wrench-screwdriver.png]] tweak
			*[[File:Music-plus.png]] soundadd
			*[[File:Music-minus.png]] sounddel
			*[[File:Tick-circle.png]] rscadd
			*[[File:Cross-circle.png]] rscdel
			*[[File:Image-plus.png]] imageadd
			*[[File:Image-minus.png]] imagedel
			*[[File:Spell-check.png]] spellcheck
			*[[File:Burn-exclamation.png]] experiment

	{{Contribution guides}}		{{Contribution guides}}
	[[Category:Guides]] [[Category:Game Resources]]		[[Category:Guides]] [[Category:Game Resources]]

tgstation>Deantwo: /* Pull Requests */ Tiny fix for humors sake.

2015-02-08T20:11:05Z

Pull Requests: Tiny fix for humors sake.

← Older revision		Revision as of 20:11, 8 February 2015
Line 13:		Line 13:
	## Go to <code>/master/html/changelogs/</code> on your branch.		## Go to <code>/master/html/changelogs/</code> on your branch.
	## Create file <code>''USERNAME-BRANCHNAME''.yml</code> in the folder, where 'BRANCHNAME' the name of the branch on your fork and 'USERNAME' is your github username.		## Create file <code>''USERNAME-BRANCHNAME''.yml</code> in the folder, where 'BRANCHNAME' the name of the branch on your fork and 'USERNAME' is your github username.
	##* Example: <code>Deantwo-~~ChemMasterGetsGloomy~~.yml</code>		##* Example: <code>Deantwo-BrainlessShooting.yml</code>
	##* File name is not super important but helps the maintainers know who made the file and which PR it is related to. Also prevents conflicts since two files won't have the same name.		##* File name is not super important but helps the maintainers know who made the file and which PR it is related to. Also prevents conflicts since two files won't have the same name.
	# Copy the contents of [https://github.com/tgstation/-tg-station/blob/master/html/changelogs/example.yml this].		# Copy the contents of [https://github.com/tgstation/-tg-station/blob/master/html/changelogs/example.yml this].
Line 28:		Line 28:

	changes:		changes:
	- rscadd: "Added ~~grenades~~ for everyone."		- rscadd: "Added laser rifles for everyone."
	- rscdel: "Removed everyone's brains."		- rscdel: "Removed everyone's brains."

tgstation>Paprika: /* Pull Requests */

2015-02-08T20:03:15Z

Pull Requests

← Older revision		Revision as of 20:03, 8 February 2015
Line 12:		Line 12:
	# Create <code>html/changelogs/''USERNAME-BRANCHNAME''.yml</code>.		# Create <code>html/changelogs/''USERNAME-BRANCHNAME''.yml</code>.
	## Go to <code>/master/html/changelogs/</code> on your branch.		## Go to <code>/master/html/changelogs/</code> on your branch.
	## Create file <code>''USERNAME-BRANCHNAME''.yml</code> in the folder, where 'BRANCHNAME' the name of the branch.		## Create file <code>''USERNAME-BRANCHNAME''.yml</code> in the folder, where 'BRANCHNAME' the name of the branch on your fork and 'USERNAME' is your github username.
	##* Example: <code>Deantwo-ChemMasterGetsGloomy.yml</code>		##* Example: <code>Deantwo-ChemMasterGetsGloomy.yml</code>
	##* File name is not super important but helps the maintainers know who made the file and which PR it is related to. Also prevents conflicts since two files won't have the same name.		##* File name is not super important but helps the maintainers know who made the file and which PR it is related to. Also prevents conflicts since two files won't have the same name.