Skip to content

Commit f197788

Browse files
committed
Update docs for 6.1.0
1 parent fa07a2f commit f197788

15 files changed

+14091
-194
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[6.1.0 (TBD)](https://github.com/Orange-OpenSource/hurl/blob/master/CHANGELOG.md#6.1.0)
1+
[6.1.0 (2024-03-12)](https://github.com/Orange-OpenSource/hurl/blob/master/CHANGELOG.md#6.1.0)
22
========================================================================================================================
33

44
Thanks to

README.md

+42-10
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Finally, Hurl is easy to <b>integrate in CI/CD</b>, with text, JUnit, TAP and HT
147147
Hurl is a lightweight binary written in [Rust]. Under the hood, Hurl HTTP engine is
148148
powered by [libcurl], one of the most powerful and reliable file transfer libraries.
149149
With its text file format, Hurl adds syntactic sugar to run and test HTTP requests,
150-
but it's still the [curl] that we love: __fast__, __efficient__ and __HTTP/3 ready__.
150+
but it's still the [curl] that we love: __fast__, __efficient__ and __IPv6 / HTTP/3 ready__.
151151

152152
# Feedbacks
153153

@@ -209,6 +209,7 @@ HTTP 200
209209
* [JSON Output](#json-output)
210210
* [Others](#others)
211211
* [HTTP Version](#http-version)
212+
* [IP Address](#ip-address)
212213
* [Polling and Retry](#polling-and-retry)
213214
* [Delaying Requests](#delaying-requests)
214215
* [Skipping Requests](#skipping-requests)
@@ -909,7 +910,7 @@ $ hurl --json *.hurl
909910

910911
### HTTP Version
911912

912-
Testing HTTP version (HTTP/1.0, HTTP/1.1, HTTP/2 or HTTP/3):
913+
Testing HTTP version (HTTP/1.0, HTTP/1.1, HTTP/2 or HTTP/3) can be done using implicit asserts:
913914

914915
```hurl
915916
GET https://foo.com
@@ -921,6 +922,37 @@ HTTP/2 200
921922

922923
[Doc](https://hurl.dev/docs/asserting-response.html#version-status)
923924

925+
Or explicit:
926+
927+
```hurl
928+
GET https://foo.com
929+
HTTP 200
930+
[Asserts]
931+
version == "3"
932+
933+
GET https://bar.com
934+
HTTP 200
935+
[Asserts]
936+
version == "2"
937+
version toFloat > 1.1
938+
```
939+
940+
[Doc](https://hurl.dev/docs/asserting-response.html#version-assert)
941+
942+
### IP Address
943+
944+
Testing the IP address of the response, as a string. This string may be IPv6 address:
945+
946+
```hurl
947+
GET https://foo.com
948+
HTTP 200
949+
[Asserts]
950+
ip == " 2001:0db8:85a3:0000:0000:8a2e:0370:733"
951+
ip startsWith "2001"
952+
ip isIpv6
953+
```
954+
955+
924956
### Polling and Retry
925957

926958
Retry request on any errors (asserts, captures, status code, runtime etc...):
@@ -1042,7 +1074,7 @@ POST https://example.org
10421074
X-Token: {{token}}
10431075
{
10441076
"name": "Alice",
1045-
"value: 100
1077+
"value": 100
10461078
}
10471079
HTTP 200
10481080
```
@@ -1063,7 +1095,7 @@ POST https://example.org
10631095
X-Token: {{token}}
10641096
{
10651097
"name": "Alice",
1066-
"value: 100
1098+
"value": 100
10671099
}
10681100
HTTP 200
10691101
```
@@ -1397,7 +1429,7 @@ Precompiled binary is available at [Hurl latest GitHub release]:
13971429

13981430
```shell
13991431
$ INSTALL_DIR=/tmp
1400-
$ VERSION=6.0.0
1432+
$ VERSION=6.1.0
14011433
$ curl --silent --location https://github.com/Orange-OpenSource/hurl/releases/download/$VERSION/hurl-$VERSION-x86_64-unknown-linux-gnu.tar.gz | tar xvz -C $INSTALL_DIR
14021434
$ export PATH=$INSTALL_DIR/hurl-$VERSION-x86_64-unknown-linux-gnu/bin:$PATH
14031435
```
@@ -1407,15 +1439,15 @@ $ export PATH=$INSTALL_DIR/hurl-$VERSION-x86_64-unknown-linux-gnu/bin:$PATH
14071439
For Debian / Ubuntu, Hurl can be installed using a binary .deb file provided in each Hurl release.
14081440

14091441
```shell
1410-
$ VERSION=6.0.0
1442+
$ VERSION=6.1.0
14111443
$ curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/$VERSION/hurl_${VERSION}_amd64.deb
14121444
$ sudo apt update && sudo apt install ./hurl_${VERSION}_amd64.deb
14131445
```
14141446

14151447
For Ubuntu (bionic, focal, jammy, noble), Hurl can be installed from `ppa:lepapareil/hurl`
14161448

14171449
```shell
1418-
$ VERSION=6.0.0
1450+
$ VERSION=6.1.0
14191451
$ sudo apt-add-repository -y ppa:lepapareil/hurl
14201452
$ sudo apt install hurl="${VERSION}"*
14211453
```
@@ -1600,9 +1632,9 @@ Please follow the [contrib on Windows section].
16001632
[GitHub]: https://github.com/Orange-OpenSource/hurl
16011633
[libcurl]: https://curl.se/libcurl/
16021634
[star Hurl on GitHub]: https://github.com/Orange-OpenSource/hurl/stargazers
1603-
[HTML]: /docs/standalone/hurl-6.0.0.html
1604-
[PDF]: /docs/standalone/hurl-6.0.0.pdf
1605-
[Markdown]: /docs/standalone/hurl-6.0.0.md
1635+
[HTML]: /docs/standalone/hurl-6.1.0.html
1636+
[PDF]: /docs/standalone/hurl-6.1.0.pdf
1637+
[Markdown]: /docs/standalone/hurl-6.1.0.md
16061638
[JSON body]: https://hurl.dev/docs/request.html#json-body
16071639
[XML body]: https://hurl.dev/docs/request.html#xml-body
16081640
[XML multiline string body]: https://hurl.dev/docs/request.html#multiline-string-body

bin/docs/build_readme.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -140,19 +140,19 @@ def replace(text: str, dest: str) -> str:
140140
),
141141
# TODO: extract version from Cargo.toml
142142
(
143-
"[HTML]: /docs/standalone/hurl-6.0.0.html",
144-
"[HTML]: /docs/standalone/hurl-6.0.0.html",
145-
"[HTML]: https://hurl.dev/assets/docs/hurl-6.0.0.html.gz",
143+
"[HTML]: /docs/standalone/hurl-6.1.0.html",
144+
"[HTML]: /docs/standalone/hurl-6.1.0.html",
145+
"[HTML]: https://hurl.dev/assets/docs/hurl-6.1.0.html.gz",
146146
),
147147
(
148-
"[PDF]: /docs/standalone/hurl-6.0.0.pdf",
149-
"[PDF]: /docs/standalone/hurl-6.0.0.pdf",
150-
"[PDF]: https://hurl.dev/assets/docs/hurl-6.0.0.pdf.gz",
148+
"[PDF]: /docs/standalone/hurl-6.1.0.pdf",
149+
"[PDF]: /docs/standalone/hurl-6.1.0.pdf",
150+
"[PDF]: https://hurl.dev/assets/docs/hurl-6.1.0.pdf.gz",
151151
),
152152
(
153-
"[Markdown]: https://hurl.dev/docs/standalone/hurl-6.0.0.html",
154-
"[Markdown]: /docs/standalone/hurl-6.0.0.md",
155-
"[Markdown]: https://hurl.dev/assets/docs/hurl-6.0.0.md.gz",
153+
"[Markdown]: https://hurl.dev/docs/standalone/hurl-6.1.0.html",
154+
"[Markdown]: /docs/standalone/hurl-6.1.0.md",
155+
"[Markdown]: https://hurl.dev/assets/docs/hurl-6.1.0.md.gz",
156156
),
157157
]
158158
for old, new_for_github, new_for_crates in snippets:

0 commit comments

Comments
 (0)