open-telemetry / opentelemetry-collector-releases

OpenTelemetry Collector Official Releases
https://opentelemetry.io
Apache License 2.0
252 stars 162 forks source link

Add table with released artifacts to Github releases #697

Open mx-psi opened 1 month ago

mx-psi commented 1 month ago
We release a lot of artifacts on each release. To make it easier to navigate, we can automate generating a table for all artifacts. For example something like this: otelcol otelcol-contrib otelcol-k8s otelcol-otlp
Checksum txt txt txt txt
darwin/amd64 tar.gz ... ... ...
darwin/arm64 tar.gz ... ... ...
... ... ... ... ..
linux/amd64 tar.gz, deb, rpm ... ... ...

We may want to generate multiple tables for signatures and SBOMs, or alternative just make the rows things like "linux/amd64 deb SBOM".

mark-pictor-csec commented 1 month ago

I like the idea of a table, but I'm a little confused by what's in the sample above.

For example, by checksum, did you mean revision? A checksum of the binary would differ for each arch, so I don't think putting it at the top would work well.

Rather than multiple tables, I'd suggest a single table with terse links e.g. the linux/amd64 row would look something like this:

otelcol otelcol-contrib otelcol-k8s otelcol-otlp
linux/amd64 [sums]()/[tar.gz]()/[deb]()/[rpm]() [sums]()/[tar.gz]()/[deb]()/[rpm]() [sums]()/[tar.gz]()/[deb]()/[rpm]() [sums]()/[tar.gz]()/[deb]()/[rpm]()
mx-psi commented 1 month ago

The first column should say "checksums" rather than "checksum". I was referring to this file in particular: https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v0.111.0/opentelemetry-collector-releases_otelcol-contrib_checksums.txt

My concern with a single table is that there are too many things for a single distro-arch combination, namely (for the worst case):

That seems like way too many things to put in a single cell :smile:

7h3-3mp7y-m4n commented 1 month ago

hey, I would like to work on this :)

mx-psi commented 1 month ago

Assigned to you @7h3-3mp7y-m4n !