Managing breaking changes upstream

Open
#4,102 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
git, github-actions
Domain
ci-cd, devops

Research direction

Start with issue 4090 and the proposed monorepo issue 4063, then inspect test-pr.yml and the _update-deps/runtimeverification/... branch convention. Decide which upstream-change strategy is in scope and define how its failure handling, staging, or revert flow would be validated across downstream repositories.

Written by the indexing model from the issue text.

Description

Currently, when we have breaking changes in upstream repos, it can cause blockages in merging things downstream. Here we are recording the issues: https://github.com/runtimeverification/k/issues/4090

There are three proposed solutions to this:

  • Monorepo: https://github.com/runtimeverification/k/issues/4063.
  • Auto-revert: When an _update-deps job fails, automatically open a PR into the upstream repo that reverts the given change there, and allow any developer to approve it so that it rolls the upstream repo back to a prior state.
  • Downstream testing: When a PR is approved for merge in an upstream repo, move it into a staging area and automatically open a PR downstream running the test-suite there. If that test-suite doesn't pass, kick the PR out of the staging area.

The monorepo for all of K solves this issue for dependencies of any depth, but the other ones only solve it for depth 1.

  • Auto-revert approach: on test-pr.yml, anything that should trigger auto-revert upstream adds a failure block which:
    • Checks the branch. If it's _update-deps/runtimeverification/..., then it figures out which repo sent that update, and tags the devops repo to open a PR into that repo with the revert of that latest commit.
Dominant language
Python
Stars
591
Forks
163
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 runtimeverification/k

All issues in runtimeverification/k

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.