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

docs: adding SLSA verification steps to READMEs #344

Merged
merged 5 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
7 changes: 7 additions & 0 deletions PROVENANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages.

As part of [SLSA requirements for level 3 compliance](https://slsa.dev/spec/v1.0/requirements), LaunchDarkly publishes provenance attestations about our SDK package builds to npm for distribution alongside our packages.

For npm packages that are published with provenance, npm automatically [verifies the authenticity of the package using Sigstore](https://docs.npmjs.com/generating-provenance-statements#about-npm-provenance).
4 changes: 4 additions & 0 deletions packages/sdk/akamai-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ yarn && yarn build && cd packages/sdk/akamai-base
yarn test
```

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/sdk/akamai-edgekv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ yarn && yarn build && cd packages/sdk/akamai-edgekv
yarn test
```

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/sdk/cloudflare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ yarn && yarn build && cd packages/sdk/cloudflare
yarn test
```

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/sdk/react-native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ echo "MOBILE_KEY=mob-abc" >> packages/sdk/react-native/example/.env
yarn && yarn ios-go
```

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/sdk/server-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ We run integration tests for all our SDKs using a centralized test harness. This

We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/sdk/vercel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ yarn && yarn build && cd packages/sdk/vercel
yarn test
```

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This library is a beta version and should not be considered ready for production

See [Contributing](../CONTRIBUTING.md).

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/sdk-server-edge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This library is a beta version and should not be considered ready for production

See [Contributing](../CONTRIBUTING.md).

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/sdk-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ This project contains Typescript classes and interfaces that are applicable to s

See [Contributing](../CONTRIBUTING.md).

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/store/node-server-sdk-dynamodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ const factory = DynamoDBFeatureStore({ cacheTTL: 0 });

We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down
4 changes: 4 additions & 0 deletions packages/store/node-server-sdk-redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ const factory = RedisFeatureStoreFactory({ cacheTTL: 0 });

We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.

## Verifying SDK packages with the SLSA framework (Supply-chain Levels for Software Artifacts)

LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).

## About LaunchDarkly

- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
Expand Down