summaryrefslogtreecommitdiff
path: root/docs/topics/CHANGELOG.md.html
blob: 4e656c7dde8db0e4aad8e19bf9f144f3207a596c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Lua-System docs</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Lua-System</h1>


<h2>Contents</h2>
<ul>
<li><a href="#Versioning">Versioning </a></li>
<li><a href="#Version_history">Version history </a></li>
</ul>


<h2>Topics</h2>
<ul class="">
  <li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
  <li><strong>CHANGELOG</strong></li>
  <li><a href="../topics/LICENSE.md.html">MIT License</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../index.html">system</a></li>
</ul>

</div>

<div id="content">


<h1>CHANGELOG</h1>

<p><a name="Versioning"></a></p>
<h2>Versioning</h2>

<p>This library is versioned based on Semantic Versioning (<a href="https://semver.org/">SemVer</a>).</p>

<h4>Version scoping</h4>

<p>The scope of what is covered by the version number excludes:</p>

<ul>
    <li>error messages; the text of the messages can change, unless specifically documented.</li>
</ul>

<h4>Releasing new versions</h4>

<ul>
    <li>create a release branch</li>
    <li>update the changelog below</li>
    <li>update version and copyright-years in <code>./LICENSE.md</code> and <code>./src/core.c</code> (in module constants)</li>
    <li>create a new rockspec and update the version inside the new rockspec:<br/>
    <code>cp luasystem-scm-0.rockspec ./rockspecs/luasystem-X.Y.Z-1.rockspec</code></li>
    <li>clean and render the docs: run <code>ldoc .</code></li>
    <li>commit the changes as <code>Release vX.Y.Z</code></li>
    <li>push the commit, and create a release PR</li>
    <li>after merging tag the release commit with <code>vX.Y.Z</code></li>
    <li>upload to LuaRocks:<br/>
    <code>luarocks upload ./rockspecs/luasystem-X.Y.Z-1.rockspec --api-key=ABCDEFGH</code></li>
    <li>test the newly created rock:<br/>
    <code>luarocks install luasystem</code></li>
</ul>

<p><a name="Version_history"></a></p>
<h2>Version history</h2>

<h3>Version 0.3.0, released 15-Dec-2023</h3>

<ul>
    <li>Feat: on Windows <a href="../index.html#sleep">sleep</a> now has a precision parameter</li>
    <li>Feat: <a href="../index.html#setenv">setenv</a> added to set environment variables.</li>
    <li>Feat: <a href="../index.html#getenvs">getenvs</a> added to list environment variables.</li>
    <li>Feat: <a href="../index.html#getenv">getenv</a> added to get environment variable previously set (Windows).</li>
    <li>Feat: <a href="../index.html#random">random</a> added to return high-quality random bytes</li>
    <li>Feat: <a href="../index.html#isatty">isatty</a> added to check if a file-handle is a tty</li>
</ul>

<h3>Version 0.2.1, released 02-Oct-2016</h3>

<h3>Version 0.2.0, released 08-May-2016</h3>

<h3>Version 0.1.1, released 10-Apr-2016</h3>

<h3>Version 0.1.0, released 11-Feb-2016</h3>

<ul>
    <li>initial release</li>
</ul>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2023-12-15 13:15:09 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>