Shopify / Shopify/shipit-engine

Rollback system is confusing

Open
#851 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
1.5k
Forks
154
Avg merge
2h 26m
Merged PRs (30d)
3

Description

Often, we know that e.g. "SHA 599db8 is good" or "SHA 32df81 is bad"

screen shot 2018-12-04 at 11 02 38 am

So I see this, and I think, clicking this button, what will happen? Will I be on 892... or 599... after the operation completes? Then I look to the deploy below, see the same SHA referenced, and have to think some more. In the confusion of an incident, this potential for confusion doesn't help my confidence in picking the right course of action swiftly. Maybe I just don't rollback enough, but I figure that I cannot be the only one.

Main proposal

Given knowledge that "SHA 599db8 is good" or "SHA 32df81 is bad", I think that perhaps it would be more clear if the rollback button said directly instead, Rollback to 599db80428, because to this deploy seems rather obvious and doesn't add much

Secondary proposal

Further, putting the full SHA from git log onto the message somewhere onto the page could help with cmd+f => paste in ba253674eb4831031fbf6131ec19874d80aba975, but I can accept grabbing 8 or so chars from git log and truncating it myself

Thoughts?

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the rollback button and the deploy details shown in the deployment coordination UI, then compare which commit SHA each currently represents. Done means the rollback action clearly names its target SHA, with the full SHA available on the page for searching; no specific file or test is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
devops, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.