aws / s2n-tls

An implementation of the TLS/SSL protocols
https://aws.github.io/s2n-tls/usage-guide/
Apache License 2.0
4.51k stars 704 forks source link

Sidetrail readme contains invalid instructions for running tests locally #4466

Open goatgoose opened 5 months ago

goatgoose commented 5 months ago

Problem:

The sidetrail readme contains instructions for running the sidetrail tests locally. These instructions indicate that a sidetrail Dockerfile should be used to build an image. However, this Dockerfile was removed in https://github.com/aws/s2n-tls/pull/3518, so it no longer exists.

Solution:

We should remove the invalid reference from the readme, and instead link to the instillation scripts to setup the dependencies locally without docker.

After https://github.com/aws/s2n-tls/issues/4479 is resolved, we can link to the sidetrail docker image again.

maddeleine commented 5 months ago

Hah, apparently someone has noticed this before: https://github.com/aws/s2n-tls/issues/3881