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

Add table with released artifacts to Github releases #697

Open
mx-psi opened this issue Oct 16, 2024 · 4 comments
Open

Add table with released artifacts to Github releases #697

mx-psi opened this issue Oct 16, 2024 · 4 comments
Assignees
Labels
artifact:deb Issues related to DEB packages artifact:rpm Issues related to RPM packages documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mx-psi
Copy link
Member

mx-psi commented Oct 16, 2024

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".

@mx-psi mx-psi added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Oct 16, 2024
@dosubot dosubot bot added artifact:deb Issues related to DEB packages artifact:rpm Issues related to RPM packages labels Oct 16, 2024
@mark-pictor-csec
Copy link

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
Copy link
Member Author

mx-psi commented Oct 16, 2024

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):

  • The deb
  • The rpm
  • The tar.gz
  • The .pem for the deb
  • The .sig for the deb
  • The .pem for the rpm
  • The .sig for the rpm
  • The SBOM for the deb
  • The .pem for the SBOM for the deb
  • The .sig for the SBOM for the deb
  • (Same thing for tar.gz and same thing for the rpm)

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

@7h3-3mp7y-m4n
Copy link

hey, I would like to work on this :)

@mx-psi
Copy link
Member Author

mx-psi commented Oct 17, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
artifact:deb Issues related to DEB packages artifact:rpm Issues related to RPM packages documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants