Skip to content

Commit 587e8bc

Browse files
nicoloboschinicoloboschi
authored
docs: 1.0.0 changelog (#395)
1 parent 494089d commit 587e8bc

File tree

2 files changed

+164
-11
lines changed

2 files changed

+164
-11
lines changed

‎docs/modules/ROOT/pages/changelog.adoc

Lines changed: 123 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Changelog
22

3-
The RAGStack changelog provides information about new features, bug fixes, dependency versions and breaking changes in each release.
3+
The RAGStack changelog provides information about dependency versions for each release.
44

55
For more, see:
66

@@ -9,6 +9,128 @@ For more, see:
99
* https://pypi.org/project/ragstack-ai/[PyPI^]{external-link-icon}
1010
1111
12+
== `ragstack-ai`@1.0.0 (2024-04-24)
13+
14+
[caption=]
15+
.Requirements
16+
[%autowidth]
17+
[cols="2*",options="header"]
18+
|===
19+
| Library | Version
20+
21+
22+
| ragstack-ai-colbert
23+
| ==1.0.0
24+
25+
| ragstack-ai-langchain
26+
| ==1.0.0
27+
28+
| ragstack-ai-llamaindex
29+
| ==1.0.0
30+
31+
32+
|===
33+
34+
35+
36+
== `ragstack-ai-llamaindex`@1.0.0 (2024-04-24)
37+
38+
[caption=]
39+
.Requirements
40+
[%autowidth]
41+
[cols="2*",options="header"]
42+
|===
43+
| Library | Version
44+
45+
46+
| astrapy
47+
| <2,>=1
48+
49+
| cassio
50+
| <0.2.0,>=0.1.4
51+
52+
| llama-index
53+
| ==0.10.31
54+
55+
| ragstack-ai-colbert (via extra `"colbert"`)
56+
| ==1.0.0
57+
58+
| unstructured
59+
| ==0.12.5
60+
61+
62+
|===
63+
64+
65+
66+
67+
== `ragstack-ai-langchain`@1.0.0 (2024-04-24)
68+
69+
[caption=]
70+
.Requirements
71+
[%autowidth]
72+
[cols="2*",options="header"]
73+
|===
74+
| Library | Version
75+
76+
77+
| astrapy
78+
| <2,>=1
79+
80+
| cassio
81+
| <0.2.0,>=0.1.4
82+
83+
| langchain
84+
| https://datastax.github.io/ragstack-ai/api_reference/1.0.0/langchain[==0.1.16]{external-link-icon}
85+
86+
| langchain-astradb
87+
| ==0.2.0
88+
89+
| langchain-community
90+
| ==0.0.34
91+
92+
| langchain-core
93+
| ==0.1.45
94+
95+
| ragstack-ai-colbert (via extra `"colbert"`)
96+
| ==1.0.0
97+
98+
| unstructured
99+
| ==0.12.5
100+
101+
102+
|===
103+
104+
105+
106+
107+
== `ragstack-ai-colbert`@1.0.0 (2024-04-24)
108+
109+
[caption=]
110+
.Requirements
111+
[%autowidth]
112+
[cols="2*",options="header"]
113+
|===
114+
| Library | Version
115+
116+
117+
| cassio
118+
| <0.2.0,>=0.1.7
119+
120+
| colbert-ai
121+
| ==0.2.19
122+
123+
| pyarrow
124+
| ==14.0.1
125+
126+
| torch
127+
| ==2.2.1
128+
129+
130+
|===
131+
132+
133+
12134

13135
== 0.10.0 (2024-03-15)
14136

‎scripts/generate-changelog.py

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,67 @@
55
exit(1)
66
import sys
77

8-
IMPORTANT_DEPENDENCIES = ["langchain", "langchain-astradb", "langchain-community", "langchain-core", "llama-index", "astrapy", "cassio", "unstructured"]
8+
IMPORTANT_DEPENDENCIES = [
9+
"ragstack-ai-langchain",
10+
"ragstack-ai-colbert",
11+
"ragstack-ai-llamaindex",
12+
"langchain",
13+
"langchain-astradb",
14+
"langchain-community",
15+
"langchain-core",
16+
"llama-index",
17+
"astrapy",
18+
"cassio",
19+
"unstructured",
20+
"colbert-ai",
21+
"torch",
22+
"pyarrow"
23+
]
924

1025

1126
def main():
1227
if len(sys.argv) < 2:
13-
print("Usage: generate-changelog.py {version}")
28+
print("Usage: generate-changelog.py {version} {package_name}")
1429
sys.exit(1)
1530
package_version = sys.argv[1]
16-
url = f"https://pypi.org/pypi/ragstack-ai/{package_version}/json"
31+
root_package_name = sys.argv[2]
32+
url = f"https://pypi.org/pypi/{root_package_name}/{package_version}/json"
1733
deps_str = ""
1834
json_response = requests.get(url).json()
1935
requires = json_response['info']['requires_dist']
2036
for require in requires:
21-
split = require.split(' ')
22-
package_name = split[0]
37+
version_range = ""
38+
extra = ""
39+
require = require.replace(" ", "")
40+
if ";extra" in require:
41+
extra = require[require.index(";extra") + 8:]
42+
require = require[:require.index(";extra")]
43+
44+
for i in range(len(require)):
45+
if require[i] == "=":
46+
package_name = require[:i]
47+
version_range = require[i:]
48+
break
49+
if require[i] == ">" or require[i] == "<":
50+
package_name = require[:i]
51+
version_range = require[i:]
52+
break
53+
if not version_range:
54+
raise ValueError(f"Could not parse version range from {require}")
2355
for important_dependency in IMPORTANT_DEPENDENCIES:
2456
if package_name.startswith(important_dependency + "["):
2557
package_name = important_dependency
2658
break
2759
if package_name in IMPORTANT_DEPENDENCIES:
28-
version_range = split[1].replace('(', '').replace(')', '')
2960
if package_name == "langchain":
30-
version_range = f"https://datastax.github.io/ragstack-ai/api_reference/{package_version}/langchain[{version_range}]{{external-link-icon}}" # noqa
31-
32-
deps_str += f"\n| {package_name}\n| {version_range}\n"
61+
version_range = f"https://datastax.github.io/ragstack-ai/api_reference/{package_version}/langchain[{version_range}]{{external-link-icon}}" # noqa
62+
extra_str = f" (via extra `{extra}`)" if extra else ""
63+
deps_str += f"\n| {package_name}{extra_str}\n| {version_range}\n"
3364

3465
release_date = json_response["urls"][0]["upload_time"][:10]
3566

3667
print(f"""
37-
== {package_version} ({release_date})
68+
== `{root_package_name}`@{package_version} ({release_date})
3869
3970
[caption=]
4071
.Requirements

0 commit comments

Comments
 (0)