Guide to Changelogs: Difference between revisions
no edit summary
imported>Deantwo m (→Pull Requests: Tiny fix for humors sake.) |
imported>Jordie0608 No edit summary |
||
| 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 == | ||
=== | === 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." | ||
=== | === 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. | |||
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]] | ||