Skip to content

Commit d804440

Browse files
committed
[doc] Fix install commands to use full path or URL
1 parent 052c181 commit d804440

File tree

2 files changed

+35
-13
lines changed

2 files changed

+35
-13
lines changed

.github/workflows/exist.yml

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,30 +72,45 @@ jobs:
7272
echo "$result" | grep -q "request module loaded" || (echo "FAIL: request module not loaded" && exit 1)
7373
7474
# Smoke tests: verify functions work
75-
- name: Test exrequest:method returns GET
75+
- name: Test exrequest:method returns POST
7676
run: |
77-
result=$(curl -sf -u admin: \
78-
'http://localhost:8080/exist/rest/db?_query=import%20module%20namespace%20exrequest%20%3D%20%22http%3A%2F%2Fexquery.org%2Fns%2Frequest%22%3B%20exrequest%3Amethod()&_wrap=no')
77+
result=$(curl -s -u admin: -H "Content-Type: application/xml" --data '
78+
<query xmlns="http://exist.sourceforge.net/NS/exist">
79+
<text><![CDATA[
80+
import module namespace exrequest = "http://exquery.org/ns/request";
81+
exrequest:method()
82+
]]></text>
83+
</query>' "http://localhost:8080/exist/rest/db")
7984
echo "$result"
80-
echo "$result" | grep -q "GET" || (echo "FAIL: expected GET" && exit 1)
85+
echo "$result" | grep -q "POST" || (echo "FAIL: expected POST" && exit 1)
8186
8287
- name: Test exrequest:scheme returns http
8388
run: |
84-
result=$(curl -sf -u admin: \
85-
'http://localhost:8080/exist/rest/db?_query=import%20module%20namespace%20exrequest%20%3D%20%22http%3A%2F%2Fexquery.org%2Fns%2Frequest%22%3B%20exrequest%3Ascheme()&_wrap=no')
89+
result=$(curl -s -u admin: -H "Content-Type: application/xml" --data '
90+
<query xmlns="http://exist.sourceforge.net/NS/exist">
91+
<text><![CDATA[
92+
import module namespace exrequest = "http://exquery.org/ns/request";
93+
exrequest:scheme()
94+
]]></text>
95+
</query>' "http://localhost:8080/exist/rest/db")
8696
echo "$result"
8797
echo "$result" | grep -q "http" || (echo "FAIL: expected http" && exit 1)
8898
8999
- name: Test exrequest:parameter with default value
90100
run: |
91-
result=$(curl -sf -u admin: \
92-
'http://localhost:8080/exist/rest/db?_query=import%20module%20namespace%20exrequest%20%3D%20%22http%3A%2F%2Fexquery.org%2Fns%2Frequest%22%3B%20exrequest%3Aparameter(%22missing%22%2C%20%22fallback%22)&_wrap=no')
101+
result=$(curl -s -u admin: -H "Content-Type: application/xml" --data '
102+
<query xmlns="http://exist.sourceforge.net/NS/exist">
103+
<text><![CDATA[
104+
import module namespace exrequest = "http://exquery.org/ns/request";
105+
exrequest:parameter("missing", "fallback")
106+
]]></text>
107+
</query>' "http://localhost:8080/exist/rest/db")
93108
echo "$result"
94109
echo "$result" | grep -q "fallback" || (echo "FAIL: expected fallback" && exit 1)
95110
96111
- name: Test exrequest:header-names returns non-empty sequence
97112
run: |
98-
result=$(curl -sf -u admin: -H "Content-Type: application/xml" --data '
113+
result=$(curl -s -u admin: -H "Content-Type: application/xml" --data '
99114
<query xmlns="http://exist.sourceforge.net/NS/exist">
100115
<text><![CDATA[
101116
import module namespace exrequest = "http://exquery.org/ns/request";
@@ -107,7 +122,7 @@ jobs:
107122
108123
- name: Test exrequest:set-attribute and exrequest:attribute round-trip
109124
run: |
110-
result=$(curl -sf -u admin: -H "Content-Type: application/xml" --data '
125+
result=$(curl -s -u admin: -H "Content-Type: application/xml" --data '
111126
<query xmlns="http://exist.sourceforge.net/NS/exist">
112127
<text><![CDATA[
113128
import module namespace exrequest = "http://exquery.org/ns/request";
@@ -120,7 +135,7 @@ jobs:
120135
121136
- name: Test exrequest:parameter-map returns a map
122137
run: |
123-
result=$(curl -sf -u admin: -H "Content-Type: application/xml" --data '
138+
result=$(curl -s -u admin: -H "Content-Type: application/xml" --data '
124139
<query xmlns="http://exist.sourceforge.net/NS/exist">
125140
<text><![CDATA[
126141
import module namespace exrequest = "http://exquery.org/ns/request";

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,17 @@ This module **coexists** with eXist's built-in request module (`http://exist-db.
66

77
## Install
88

9-
Download the `.xar` from CI build artifacts and install with the eXist-db Package Manager or the `xst` CLI:
9+
From a GitHub release:
1010

1111
```bash
12-
xst package install exist-request-0.9.0-SNAPSHOT.xar
12+
xst package install https://github.com/joewiz/exist-request/releases/download/v0.9.0-SNAPSHOT/exist-request-0.9.0-SNAPSHOT.xar
13+
```
14+
15+
From a local build:
16+
17+
```bash
18+
mvn package -DskipTests
19+
xst package install target/exist-request-0.9.0-SNAPSHOT.xar
1320
```
1421

1522
## Coexistence with the built-in request module

0 commit comments

Comments
 (0)