Skip to content

Commit caefa78

Browse files
committed
move provenance to root level
1 parent 8bd73c9 commit caefa78

File tree

3 files changed

+37
-57
lines changed

3 files changed

+37
-57
lines changed

PROVENANCE.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,62 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply
44

55
As part of [SLSA requirements for level 3 compliance](https://slsa.dev/spec/v1.0/requirements), LaunchDarkly publishes provenance about our SDK package builds using [GitHub's generic SLSA3 provenance generator](https://github.com/slsa-framework/slsa-github-generator/blob/main/internal/builders/generic/README.md#generation-of-slsa3-provenance-for-arbitrary-projects) for distribution alongside our packages. These attestations are available for download from the GitHub release page for the release version under Assets > `multiple.intoto.jsonl`.
66

7-
To verify SLSA provenance attestations, we recommend using [slsa-verifier](https://github.com/slsa-framework/slsa-verifier). Example usage for verifying a package is included below:
7+
To verify SLSA provenance attestations, we recommend using [slsa-verifier](https://github.com/slsa-framework/slsa-verifier). Example usage for verifying packages is included below.
8+
9+
### Verifying the Core Package
810

911
<!-- x-release-please-start-version -->
1012

11-
```
12-
# Set the version of the library to verify
13-
VERSION=0.10.1
13+
```bash
14+
# Set the version of the core package to verify
15+
CORE_VERSION=0.10.1
1416
```
1517

1618
<!-- x-release-please-end -->
1719

20+
```bash
21+
# Download package from PyPI
22+
$ pip download --only-binary=:all: launchdarkly-server-sdk-ai==${CORE_VERSION}
23+
24+
# Download provenance from GitHub release into same directory
25+
$ curl --location -O \
26+
https://github.com/launchdarkly/python-server-sdk-ai/releases/download/core-${CORE_VERSION}/multiple.intoto.jsonl
27+
28+
# Run slsa-verifier to verify provenance against package artifacts
29+
$ slsa-verifier verify-artifact \
30+
--provenance-path multiple.intoto.jsonl \
31+
--source-uri github.com/launchdarkly/python-server-sdk-ai \
32+
launchdarkly_server_sdk_ai-${CORE_VERSION}-py3-none-any.whl
1833
```
19-
# Download package from PyPi
20-
$ pip download --only-binary=:all: launchdarkly-server-sdk-ai==${VERSION}
2134

22-
# Download provenance from Github release into same directory
35+
### Verifying the LangChain Package
36+
37+
```bash
38+
# Set the version of the langchain package to verify
39+
LANGCHAIN_VERSION=0.1.0
40+
41+
# Download package from PyPI
42+
$ pip download --only-binary=:all: launchdarkly-server-sdk-ai-langchain==${LANGCHAIN_VERSION}
43+
44+
# Download provenance from GitHub release into same directory
2345
$ curl --location -O \
24-
https://github.com/launchdarkly/python-server-sdk-ai/releases/download/${VERSION}/multiple.intoto.jsonl
46+
https://github.com/launchdarkly/python-server-sdk-ai/releases/download/langchain-${LANGCHAIN_VERSION}/multiple.intoto.jsonl
2547

2648
# Run slsa-verifier to verify provenance against package artifacts
2749
$ slsa-verifier verify-artifact \
2850
--provenance-path multiple.intoto.jsonl \
2951
--source-uri github.com/launchdarkly/python-server-sdk-ai \
30-
launchdarkly_server_sdk_ai-${VERSION}-py3-none-any.whl
52+
launchdarkly_server_sdk_ai_langchain-${LANGCHAIN_VERSION}-py3-none-any.whl
3153
```
3254

33-
Below is a sample of expected output.
55+
### Expected Output
56+
57+
Below is a sample of expected output for successful verification:
3458

3559
```
3660
Verified signature against tlog entry index 150910243 at URL: https://rekor.sigstore.dev/api/v1/log/entries/108e9186e8c5677ab3f14fc82cd3deb769e07ef812cadda623c08c77d4e51fc03124ee7542c470a1
3761
Verified build using builder "https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@refs/tags/v2.0.0" at commit 8e2d4094b4833d075e70dfce43bbc7176008c4a1
38-
Verifying artifact launchdarkly_server_sdk_ai-0.3.0-py3-none-any.whl: PASSED
62+
Verifying artifact launchdarkly_server_sdk_ai-0.10.1-py3-none-any.whl: PASSED
3963
4064
PASSED: SLSA verification passed
4165
```

packages/core/PROVENANCE.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

release-please-config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"versioning": "default",
88
"bump-minor-pre-major": true,
99
"include-v-in-tag": false,
10-
"extra-files": ["packages/core/ldai/__init__.py", "packages/core/PROVENANCE.md"],
10+
"extra-files": ["packages/core/ldai/__init__.py", "PROVENANCE.md"],
1111
"include-component-in-tag": true,
1212
"component": "core"
1313
},
@@ -17,6 +17,7 @@
1717
"versioning": "default",
1818
"bump-minor-pre-major": true,
1919
"include-v-in-tag": false,
20+
"extra-files": ["PROVENANCE.md"],
2021
"include-component-in-tag": true,
2122
"component": "langchain"
2223
}

0 commit comments

Comments
 (0)