Guide to Changelogs: Difference between revisions
no edit summary
imported>Cheridan m (Adding more detailed steps) |
imported>Jordie0608 No edit summary |
||
Line 11: | Line 11: | ||
# Create html/changelogs/USERNAME-PR-###.yml, where ### is the number or ID of your PR. | # Create html/changelogs/USERNAME-PR-###.yml, where ### is the number or ID of your PR. | ||
# Copy the contents of [https://github.com/ | # Copy the contents of [https://github.com/tgstation/-tg-station/blob/master/html/changelogs/example.yml this]. | ||
# Fill it out. | # Fill it out. | ||
#* Make sure to set delete-after to true. | #* Make sure to set delete-after to true. | ||
Line 27: | Line 27: | ||
** 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. | ||
** <code>pip install PyYaml</code> | ** <code>pip install PyYaml</code> | ||
* With | * 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> | ||