Difference between revisions of "Guide to Changelogs"
From NSV13
Jump to navigationJump to searchimported>Oranges m (YOu can use name of branch) |
Bokkiewokkie (talk | contribs) m (make link NSV) |
||
| (13 intermediate revisions by 5 users not shown) | |||
| 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 == | ||
| − | === | + | === 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 === | ||
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. | ||
| − | # Create html/changelogs/USERNAME- | + | # Create <code>html/changelogs/''USERNAME-BRANCHNAME''.yml</code>. |
| − | # Copy the contents of [https://github.com/ | + | ## Go to <code>/master/html/changelogs/</code> on your branch. |
| − | # Fill it out. | + | ## 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-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. | ||
| + | # Copy the contents of [https://github.com/beestation/NSV13/blob/master/html/changelogs/example.yml this]. | ||
| + | # Fill it out. | ||
#* Make sure to set delete-after to true. | #* Make sure to set delete-after to true. | ||
| + | #* Also ensure you update the author name so you get credited appropriately. | ||
# '''PROOFREAD.''' Changelog entries are final after they're merged. | # '''PROOFREAD.''' Changelog entries are final after they're merged. | ||
# Add it to git so it's included with your PR. | # Add it to git so it's included with your PR. | ||
| − | + | '''File content example:''' | |
| − | + | author: Deantwo | |
| + | |||
| + | delete-after: True | ||
| + | |||
| + | changes: | ||
| + | - rscadd: "Added laser rifles for everyone." | ||
| + | - rscdel: "Removed everyone's brains." | ||
=== Updating the Changelog === | === Updating the Changelog === | ||
| Line 24: | Line 48: | ||
:''Only maintainers need to do this.'' | :''Only maintainers need to do this.'' | ||
| − | * First, install | + | * 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 | ||
** <code>pip install PyYaml</code> | ** <code>pip install PyYaml</code> | ||
| − | ** <code>pip install | + | ** <code>pip install beautifulsoup4</code> |
* With /tg/station's code, simply run makeChangelog.bat. | * With /tg/station's code, simply run makeChangelog.bat. | ||
* 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> | ||
| Line 33: | Line 58: | ||
== 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]] | ||
Latest revision as of 04:22, 11 March 2021
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.
Creating a Changelog[edit | edit source]
Online auto-creation[edit | edit source]
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[edit | edit source]
PR changelogs are temporary and just get deleted after they're merged into the master changelog.
- Create
html/changelogs/USERNAME-BRANCHNAME.yml.- Go to
/master/html/changelogs/on your branch. - Create file
USERNAME-BRANCHNAME.ymlin the folder, where 'BRANCHNAME' the name of the branch on your fork and 'USERNAME' is your github username.- Example:
Deantwo-BrainlessShooting.yml - 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.
- Example:
- Go to
- Copy the contents of this.
- Fill it out.
- Make sure to set delete-after to true.
- Also ensure you update the author name so you get credited appropriately.
- PROOFREAD. Changelog entries are final after they're merged.
- Add it to git so it's included with your PR.
File content example:
author: Deantwo
delete-after: True
changes:
- rscadd: "Added laser rifles for everyone."
- rscdel: "Removed everyone's brains."
Updating the Changelog[edit | edit source]
- Only maintainers need to do this.
- First, install python3, pip, and PyYaml:
- After installing python and ensuring it and its Scripts/ folder is in PATH, download and run get-pip.py with python.
- Once pip is installed run the following commands in your terminal
pip install PyYamlpip install beautifulsoup4
- With /tg/station's code, simply run makeChangelog.bat.
- On Linux or other codebases, run
python tools/ss13_genchangelog.py html/changelog.html html/changelogs
Screwed up Changelog[edit | edit source]
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[edit | edit source]
Any of these prefixes can be used when creating a changelog.
bugfix
wip
tweak
soundadd
sounddel
rscadd
rscdel
imageadd
imagedel
spellcheck
experiment
