open-telemetry/opentelemetry-collector-releases

Add table with released artifacts to Github releases

Open

#697 opened on Oct 16, 2024

View on GitHub
 (10 comments) (1 reaction) (0 assignees)Go (246 forks)auto 404
artifact:debartifact:rpmdocumentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (491 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Explore the existing release workflow in .github/workflows and the Makefile to understand how artifacts are built and attached to releases. Then generate a markdown table for all artifacts per release.
Tech stack
go
Domain
release
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70