release 1.0.0

LICENSE

@@ -1,22 +1,22 @@
 MIT License Terms
 =================
 
-Copyright (c) 2018-2020 Thijs Schreijer.
+Copyright (c) 2018-2022 Thijs Schreijer.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of 
-this software and associated documentation files (the "Software"), to deal in 
-the Software without restriction, including without limitation the rights to 
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
-of the Software, and to permit persons to whom the Software is furnished to do 
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all 
+The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

README.md

@@ -47,15 +47,34 @@ See [LICENSE](https://github.com/Tieske/timerwheel.lua/blob/master/LICENSE).
 History
 =======
 
+Versioning is strictly based on [Semantic Versioning](https://semver.org/).
+
+#### Releasing new versions
+
+- create a release branch
+- update the changelog below
+- update copyright-years in `./LICENSE`
+- create a new rockspec and update the version inside the new rockspec:<br/>
+  `cp timerwheel-scm-1.rockspec ./rockspecs/timerwheel-X.Y.Z-1.rockspec`
+- render the docs: run `ldoc .`
+- commit the changes as `release X.Y.Z`
+- push the commit, and create a release PR
+- after merging tag the release commit with `X.Y.Z`
+- upload to LuaRocks:<br/>
+  `luarocks upload ./rockspecs/timerwheel-X.Y.Z-1.rockspec --api-key=ABCDEFGH`
+- test the newly created rock:<br/>
+  `luarocks install timerwheel`
+
 ## 1.0.0 unreleased
 
-  - Fix: added a newline when writing errors to `stderr`, since `io.stderr:write()`
-    does not automatically do this like `print()` does.
+- Bump to 1.0 since API is stable
+- Fix: added a newline when writing errors to `stderr`, since `io.stderr:write()`
+  does not automatically do this like `print()` does.
 
 ## 0.2.0 released 11-Feb-2020
 
-  - Added `count` method to retrieve the current number of active timers
+- Added `count` method to retrieve the current number of active timers
 
 ## 0.1.0 released 01-Feb-2020
 
-  - Initial released version
+- Initial released version

docs/index.html

@@ -288,7 +288,7 @@ <h3>Returns:</h3>
 </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 2020-02-11 14:55:09 </i>
+<i style="float:right;">Last updated 2022-08-22 11:30:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/topics/readme.md.html

@@ -29,6 +29,7 @@ <h1>timerwheel.lua</h1>
 
 <h2>Contents</h2>
 <ul>
+<li><a href="#1_0_0_unreleased">1.0.0 unreleased </a></li>
 <li><a href="#0_2_0_released_11_Feb_2020">0.2.0 released 11-Feb-2020 </a></li>
 <li><a href="#0_1_0_released_01_Feb_2020">0.1.0 released 01-Feb-2020 </a></li>
 </ul>
@@ -48,8 +49,9 @@ <h2>Modules</h2>
 <div id="content">
 
 
-<p><a href="https://travis-ci.com/Tieske/timerwheel.lua"><img src="https://travis-ci.com/Tieske/timerwheel.lua.svg?branch=master" alt="Build Status"/></a>
-<a href="https://coveralls.io/github/Tieske/timerwheel.lua?branch=master"><img src="https://coveralls.io/repos/github/Tieske/timerwheel.lua/badge.svg?branch=master" alt="Coverage Status"/></a></p>
+<p><a href="https://github.com/Tieske/timerwheel.lua/actions/workflows/unix_build.yml"><img src="https://img.shields.io/github/workflow/status/Tieske/timerwheel.lua/Unix%20build?label=Unix%20build&amp;logo=linux" alt="Unix build"/></a>
+<a href="https://coveralls.io/github/Tieske/timerwheel.lua"><img src="https://img.shields.io/coveralls/github/Tieske/timerwheel.lua?logo=coveralls" alt="Coveralls code coverage"/></a>
+<a href="https://github.com/Tieske/timerwheel.lua/actions/workflows/lint.yml"><img src="https://github.com/Tieske/timerwheel.lua/workflows/Lint/badge.svg" alt="Lint"/></a></p>
 
 
 <h1>timerwheel.lua</h1>
@@ -90,6 +92,35 @@ <h1>Copyright and License</h1>
 
 <h1>History</h1>
 
+<p>Versioning is strictly based on <a href="https://semver.org/">Semantic Versioning</a>.</p>
+
+<h4>Releasing new versions</h4>
+
+<ul>
+    <li>create a release branch</li>
+    <li>update the changelog below</li>
+    <li>update copyright-years in <code>./LICENSE</code></li>
+    <li>create a new rockspec and update the version inside the new rockspec:<br/>
+    <code>cp timerwheel-scm-1.rockspec ./rockspecs/timerwheel-X.Y.Z-1.rockspec</code></li>
+    <li>render the docs: run <code>ldoc .</code></li>
+    <li>commit the changes as <code>release X.Y.Z</code></li>
+    <li>push the commit, and create a release PR</li>
+    <li>after merging tag the release commit with <code>X.Y.Z</code></li>
+    <li>upload to LuaRocks:<br/>
+    <code>luarocks upload ./rockspecs/timerwheel-X.Y.Z-1.rockspec --api-key=ABCDEFGH</code></li>
+    <li>test the newly created rock:<br/>
+    <code>luarocks install timerwheel</code></li>
+</ul>
+
+<p><a name="1_0_0_unreleased"></a></p>
+<h2>1.0.0 unreleased</h2>
+
+<ul>
+    <li>Bump to 1.0 since API is stable</li>
+    <li>Fix: added a newline when writing errors to <code>stderr</code>, since <code>io.stderr:write()</code>
+    does not automatically do this like <code>print()</code> does.</li>
+</ul>
+
 <p><a name="0_2_0_released_11_Feb_2020"></a></p>
 <h2>0.2.0 released 11-Feb-2020</h2>
 
@@ -109,7 +140,7 @@ <h2>0.1.0 released 01-Feb-2020</h2>
 </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 2020-02-11 14:55:09 </i>
+<i style="float:right;">Last updated 2022-08-22 11:30:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

rockspecs/timerwheel-1.0.0-1.rockspec

@@ -0,0 +1,36 @@
+local package_name = "timerwheel"
+local package_version = "1.0.0"
+local rockspec_revision = "1"
+local github_account_name = "Tieske"
+local github_repo_name = package_name .. ".lua"
+
+
+package = package_name
+version = package_version.."-"..rockspec_revision
+source = {
+  url = "git+https://github.com/"..github_account_name.."/"..github_repo_name..".git",
+  branch = (package_version == "scm") and "master" or nil,
+  tag = (package_version ~= "scm") and package_version or nil,
+}
+description = {
+  summary = "Timers based on a timerwheel",
+  detailed = [[
+    Creating and deleting is very fast. Typically suited for
+    setting timeouts, which usually do not execute.
+  ]],
+  homepage = "https://github.com/"..github_account_name.."/"..github_repo_name,
+  license = "MIT"
+}
+dependencies = {
+  "lua >= 5.1, < 5.5",
+  "coxpcall",
+}
+build = {
+  type = "builtin",
+  modules = {
+    ["timerwheel.init"] = "src/timerwheel/init.lua",
+  },
+  copy_directories = {
+    "docs",
+  },
+}