Files
Paradise/datum/code_revision.html

8 lines
4.4 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/code_revision - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a><a href="datum/code_revision.html#var">Var Details</a> - <a href="datum/code_revision.html#proc">Proc Details</a></header><main><h1>code_revision <aside>/<a href="datum.html">datum</a>/<a href="datum/code_revision.html">code_revision</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/revision.dm#L9"><img src="git.png" width="16" height="16" title="code/datums/revision.dm 9"></a></h1><p>Code Revision Datum</p>
<p>Allows the server code to be aware of the Git environment it is running in, and lets commit hash be viewed</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/code_revision.html#var/commit_date">commit_date</a></th><td>Date that this commit was made</td></tr><tr><th><a href="datum/code_revision.html#var/commit_hash">commit_hash</a></th><td>Current commit hash the server is running</td></tr><tr><th><a href="datum/code_revision.html#var/origin_commit">origin_commit</a></th><td>Origin commit (Only set if running TGS, and will only be different if the server is running testmerges)</td></tr><tr><th><a href="datum/code_revision.html#var/testmerges">testmerges</a></th><td>List of testmerges (If applicable)</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/code_revision.html#proc/get_testmerge_chatmessage">get_testmerge_chatmessage</a></th><td>Testmerge Chat Message Helper</td></tr><tr><th><a href="datum/code_revision.html#proc/log_info">log_info</a></th><td>Code Revision Logging Helper</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/commit_date"><aside class="declaration">var </aside>commit_date <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/revision.dm#L13"><img src="git.png" width="16" height="16" title="code/datums/revision.dm 13"></a></h3><p>Date that this commit was made</p><h3 id="var/commit_hash"><aside class="declaration">var </aside>commit_hash <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/revision.dm#L11"><img src="git.png" width="16" height="16" title="code/datums/revision.dm 11"></a></h3><p>Current commit hash the server is running</p><h3 id="var/origin_commit"><aside class="declaration">var </aside>origin_commit <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/revision.dm#L15"><img src="git.png" width="16" height="16" title="code/datums/revision.dm 15"></a></h3><p>Origin commit (Only set if running TGS, and will only be different if the server is running testmerges)</p><h3 id="var/testmerges"><aside class="declaration">var </aside>testmerges <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/revision.dm#L17"><img src="git.png" width="16" height="16" title="code/datums/revision.dm 17"></a></h3><p>List of testmerges (If applicable)</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_testmerge_chatmessage"><aside class="declaration">proc </aside>get_testmerge_chatmessage<aside>(header) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/revision.dm#L74"><img src="git.png" width="16" height="16" title="code/datums/revision.dm 74"></a></aside></h3><p>Testmerge Chat Message Helper</p>
<p>Formats testmerged PRs into a nice message
Arguments:</p>
<ul>
<li>header - Should a header be sent too</li>
</ul><h3 id="proc/log_info"><aside class="declaration">proc </aside>log_info<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/revision.dm#L39"><img src="git.png" width="16" height="16" title="code/datums/revision.dm 39"></a></aside></h3><p>Code Revision Logging Helper</p>
<p>Small proc to simplify logging all this stuff</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>