Skip to content

Commit

Permalink
chore(*) rename readme, add release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Tieske authored and nowNick committed Oct 10, 2023
1 parent 06c99ce commit 03c9379
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 11 additions & 0 deletions readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,17 @@ for the complete API.

Versioning is strictly based on [Semantic Versioning](https://semver.org/)

### Releasing new versions:

* update changelog below (PR's should be merged including a changelog entry)
* based on changelog determine new SemVer version
* create a new rockspec
* render the docs using `ldoc` (don't do this within PR's)
* commit as "release x.x.x" (do not include rockspec revision)
* tag the commit with "x.x.x" (do not include rockspec revision)
* push commit and tag
* upload rock to luarocks: `luarocks upload rockspecs/[name] --api-key=abc`

### 1.6.3 (06-Sep-2023)

* Feature: Added support for https_sni [#49](https://github.com/Kong/lua-resty-healthcheck/pull/49) (backport)
Expand Down
2 changes: 1 addition & 1 deletion config.ld
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description='Provides active and passive healthchecks (http and tcp) for OpenRes
format='discount'
file='./lib/'
dir='docs'
readme='readme.md'
readme='README.md'
sort=true
sort_modules=true
all=false
Expand Down

0 comments on commit 03c9379

Please sign in to comment.