Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: release info in docs #1794

Merged
merged 6 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 55 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,61 @@ Trestle provides tooling to help orchestrate the compliance process across a num

## Important Note:

The current version of trestle supports NIST OSCAL 1.0.0-4. There was a breaking change in OSCAL moving from
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.
The current version of trestle 3.x supports NIST OSCAL 1.1.2.
Below shows trestle versions correspondence with OSCAL versions:

OSCAL version 1.0.0 files are still handled on import but any AssessmentResults must conform to the OSCAL 1.0.4 schema, with
props instead of prop. And all files created by trestle will be output as OSCAL version 1.0.4.
```
trestle 3.x => OSCAL 1.1.2
trestle 2.x => OSCAL 1.0.4
trestle 1.x => OSCAL 1.0.2
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also add
trestle 0.37.x => OSCAL 1.0.0

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

trestle 0.37.x => OSCAL 1.0.0
```

Visit [pypi](https://pypi.org/project/compliance-trestle/#history) for trestle release history and downloads.

## Notes for install of current and older versions of trestle

#### Install of trestle 3.x

Use python 3.11.

```
python3.11 -m venv venv.trestle
source venv.trestle/bin/activate
pip install compliance-trestle==3.6.0
trestle version
Trestle version v3.6.0 based on OSCAL version 1.1.2
```

#### Install of trestle 2.x

Use python 3.9.

```
python3.9 -m venv venv.trestle
source venv.trestle/bin/activate
pip install compliance-trestle==2.6.0
trestle version
Trestle version v2.6.0 based on OSCAL version 1.0.4
```

#### Install of trestle 1.x

Use python 3.9.

Due to dependency updates since the release of trestle 1.2.0, perform the following in your venv:

```
python3.9 -m venv venv.trestle
source venv.trestle/bin/activate
pip install compliance-trestle==1.2.0
pip uninstall pydantic
pip uninstall pydantic_core
pip install pydantic==1.10.2
pip install requests
trestle version
Trestle version v1.2.0 based on OSCAL version 1.0.2
```

## Why Trestle

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

## Development status

Compliance trestle is currently stable and is based on NIST OSCAL version 1.0.4, with active development continuing.
Compliance trestle is currently stable and is based on NIST OSCAL version 1.1.2, with active development continuing.

## Contributing to Trestle

Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ This command will return the current version of Trestle and OSCAL it is using.

Running `trestle version` will return:

> Trestle version v2.0.0 based on OSCAL version 1.0.4
> Trestle version v3.x.x based on OSCAL version 1.1.2

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we say Trestle version v3.x.x based on OSCAL version 1.1.2
else with every release we will also have to necessarily update this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

It can also be used to retrieve the metadata version of the OSCAL object:

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

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

"oscal-version": "1.0.4"
"oscal-version": "1.1.2"

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

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

> Version of OSCAL object of nist catalog is: 1.0.0
> Version of OSCAL object of nist catalog is: 1.1.2

## `trestle init`

Expand Down
Loading