Prevent incompatibility issues between common and dependent repositories

Open
#603 5 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go
Domain
ci-cd

Research direction

No specific files or tests are named. Start by reviewing the repository's current CI configuration and dependency setup, then determine how to build the latest stable client_golang and/or Prometheus releases against pull requests. Done means compatibility results are reported without being required, with failures available for communication to dependent projects.

Written by the indexing model from the issue text.

Description

Common is not a stable repository, but it is being used by others that are considered stable, like client_golang and Prometheus itself.

Last week we had an incompatibility problem between common and client_golang which forced us to rush and cut a new release. We don't want to tell prometheus/common "no more breaking changes!!!!!", but it would be nice if these changes could be communicated better when they happen.

One suggestion is to add a CI workflow that tries to build the latest stable release of client_golang and/or Prometheus on pull requests. The workflow doesn't need to be "Required to pass", but if merged with failures let's communicate with dependent projects within the Prometheus organization

Dominant language
Go
Stars
297
Forks
380
Avg merge
3d 18h
Merged PRs (30d)
12

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from prometheus/common

All issues in prometheus/common

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.