Skip to content

Commit 29ccb27

Browse files
committed
docs: dev notes
1 parent 3ee8eb6 commit 29ccb27

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Utility to interact with HTTP status codes.
99
Once you require this module, you may call it with either an HTTP code or a message name. With an HTTP code, you will get the message name while with a message name you will get an HTTP code.
1010

1111
### HTTP Status Codes
12+
1213
HTTP code names, messages, and classes are respectively accessible with the property `{code}_NAME`, `{code}_MESSAGE` and `{code}_CLASS`. This includes all statuses in the [IANA HTTP Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml), with the only addition being `418 I'm a teapot`.
1314

1415
Extra status code are also made available that are not defined in the IANA registry, but used by popular software. They are grouped by category. Specific properties are exported by `http-status` under the property `extra` followed by the category name. Also, extra codes are merge with regular status codes and made available as modules available inside `http-status/lib/{category}`.
@@ -194,10 +195,9 @@ To automatically generate a new version:
194195

195196
```
196197
yarn run release
198+
197199
```
198200

199-
There is currently no CI, copy/paste the code after release. Note, commits and tags are automatically pushed before publishing.
201+
Package publication is handled by the CI/CD with GitHub action.
200202

201-
```
202-
npm publish
203-
```
203+
Note, on release, both the publish and test workflows run in parallel. Not very happy about it but I haven't found a better way.

0 commit comments

Comments
 (0)