Skip to content

Commit bdb6444

Browse files
authored
fix: release info in docs (#1794)
* Fix release info in docs. Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com> * add trestle v0 and generalize current version to 3.x.x Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com> * specify 0.3.7 explicitly Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com> * fix: version is 0.37.x Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com> --------- Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
1 parent 8171357 commit bdb6444

File tree

2 files changed

+58
-8
lines changed

2 files changed

+58
-8
lines changed

docs/index.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,61 @@ Trestle provides tooling to help orchestrate the compliance process across a num
3737

3838
## Important Note:
3939

40-
The current version of trestle supports NIST OSCAL 1.0.0-4. There was a breaking change in OSCAL moving from
41-
version 1.0.0 to 1.0.2 mainly due to `prop` becoming `props` in AssessmentResults. As a result, the current development path of trestle requires OSCAL 1.0.4, but for those who require OSCAL 1.0.0 please use trestle version 0.37.x. That version is stable but will not have any features added, and we encourage users to move to OSCAL 1.0.4.
40+
The current version of trestle 3.x supports NIST OSCAL 1.1.2.
41+
Below shows trestle versions correspondence with OSCAL versions:
4242

43-
OSCAL version 1.0.0 files are still handled on import but any AssessmentResults must conform to the OSCAL 1.0.4 schema, with
44-
props instead of prop. And all files created by trestle will be output as OSCAL version 1.0.4.
43+
```
44+
trestle 3.x => OSCAL 1.1.2
45+
trestle 2.x => OSCAL 1.0.4
46+
trestle 1.x => OSCAL 1.0.2
47+
trestle 0.37.x => OSCAL 1.0.0
48+
```
49+
50+
Visit [pypi](https://pypi.org/project/compliance-trestle/#history) for trestle release history and downloads.
51+
52+
## Notes for install of current and older versions of trestle
53+
54+
#### Install of trestle 3.x
55+
56+
Use python 3.11.
57+
58+
```
59+
python3.11 -m venv venv.trestle
60+
source venv.trestle/bin/activate
61+
pip install compliance-trestle==3.6.0
62+
trestle version
63+
Trestle version v3.6.0 based on OSCAL version 1.1.2
64+
```
65+
66+
#### Install of trestle 2.x
67+
68+
Use python 3.9.
69+
70+
```
71+
python3.9 -m venv venv.trestle
72+
source venv.trestle/bin/activate
73+
pip install compliance-trestle==2.6.0
74+
trestle version
75+
Trestle version v2.6.0 based on OSCAL version 1.0.4
76+
```
77+
78+
#### Install of trestle 1.x
79+
80+
Use python 3.9.
81+
82+
Due to dependency updates since the release of trestle 1.2.0, perform the following in your venv:
83+
84+
```
85+
python3.9 -m venv venv.trestle
86+
source venv.trestle/bin/activate
87+
pip install compliance-trestle==1.2.0
88+
pip uninstall pydantic
89+
pip uninstall pydantic_core
90+
pip install pydantic==1.10.2
91+
pip install requests
92+
trestle version
93+
Trestle version v1.2.0 based on OSCAL version 1.0.2
94+
```
4595

4696
## Why Trestle
4797

@@ -79,7 +129,7 @@ Trestle runs on most all python platforms (e.g. Linux, Mac, Windows) and is avai
79129

80130
## Development status
81131

82-
Compliance trestle is currently stable and is based on NIST OSCAL version 1.0.4, with active development continuing.
132+
Compliance trestle is currently stable and is based on NIST OSCAL version 1.1.2, with active development continuing.
83133

84134
## Contributing to Trestle
85135

docs/tutorials/cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ This command will return the current version of Trestle and OSCAL it is using.
148148

149149
Running `trestle version` will return:
150150

151-
> Trestle version v2.0.0 based on OSCAL version 1.0.4
151+
> Trestle version v3.x.x based on OSCAL version 1.1.2
152152
153153
It can also be used to retrieve the metadata version of the OSCAL object:
154154

@@ -165,7 +165,7 @@ It can also be used to retrieve the metadata version of the OSCAL object:
165165

166166
"version": "0.1.10", <<< this version here
167167

168-
"oscal-version": "1.0.4"
168+
"oscal-version": "1.1.2"
169169

170170
},
171171
...
@@ -176,7 +176,7 @@ It can also be used to retrieve the metadata version of the OSCAL object:
176176

177177
Running `trestle version -n nist -t catalog` will return:
178178

179-
> Version of OSCAL object of nist catalog is: 1.0.0
179+
> Version of OSCAL object of nist catalog is: 1.1.2
180180

181181
## `trestle init`
182182

0 commit comments

Comments
 (0)