Page MenuHomePhabricator

Rename `scap sync` to `scap sync-world`
Closed, ResolvedPublic

Description

Occasionally people run scap sync when they mean to just sync-file; let's make it really obvious?

Remains to do:

Event Timeline

A three step plan:

  • add sync-world, make sync emit a warning message
  • make a release
  • wait for a month
  • change sync to give an error, pointing at sync-world
  • learn how to count
LarsWirzenius lowered the priority of this task from High to Medium.

Possibly it would be OK to just make "scap sync" error at once, rather than have a transition period. How often is this used from scripts?

At the very least, the scripts on Beta Cluster blindly run sync and will need changing. A cut-over seems best.

Good to know. To rephrase my previous plan:

  • next release: add sync-world; make sync print warning, then run sync-world
  • announce sync-world to wikitech-l, other relevant audiences
  • some later release: drop sync

Once we have added sync-world and releng uses it, carrying the warning-printing sync is a very minor cost, so we are not in no real hurry to drop it.

Change 597828 had a related patch set uploaded (by Lars Wirzenius; owner: Lars Wirzenius):
[mediawiki/tools/scap@master] feat: rename sync to sync-world

https://gerrit.wikimedia.org/r/597828

Change 597828 merged by jenkins-bot:
[mediawiki/tools/scap@master] feat: rename sync to sync-world

https://gerrit.wikimedia.org/r/597828

Change 597832 had a related patch set uploaded (by Thcipriani; owner: Thcipriani):
[integration/config@master] beta-scap-eqiad: scap sync -> scap sync-world

https://gerrit.wikimedia.org/r/597832

I once ran scap sync foo/bar/file.php out of mistake so I welcome this change :]

My nitpick is to use s/world/all/: scap sync-all

:]

On rare occasions, the Security-Team has run scap sync to get various security patches deployed. As long as we (really just @Reedy and I) have access to sync-world or whatever it becomes, that should be fine.

@hashar, if "scap sync-all" is actually important, we can add that an alias, but I'd rather not, since aliases tend to make things confusing, when people use different names for the same thing. So I'm not adding the alias unless you explicitly say you want it.

mediawiki/tools/release/bin/deploy-promote runs scap sync when the target group is testwikis.

beta-scap-eqiad was running scap sync, now fixed.

All known cases fixed, but leaving task open in case more are found.

Change 627875 had a related patch set uploaded (by Ahmon Dancy; owner: Ahmon Dancy):
[mediawiki/tools/scap@master] sync -> sync-world in warning message

https://gerrit.wikimedia.org/r/627875

Change 627875 merged by jenkins-bot:
[mediawiki/tools/scap@master] sync -> sync-world in warning message

https://gerrit.wikimedia.org/r/627875

LarsWirzenius lowered the priority of this task from Medium to Low.Sep 16 2020, 4:42 PM

Change 628162 had a related patch set uploaded (by Ahmon Dancy; owner: Ahmon Dancy):
[mediawiki/tools/scap@master] scap sync-world: Don't ask for confirmation

https://gerrit.wikimedia.org/r/628162

Change 628162 merged by jenkins-bot:
[mediawiki/tools/scap@master] scap sync-world: Don't ask for confirmation

https://gerrit.wikimedia.org/r/628162

This has been deployed for a while now, so closing the ticket. Please reopen if you find anywhere that needs to be fixed.

Change 597832 abandoned by Jforrester:
[integration/config@master] jjb: [beta-scap-eqiad]: scap sync -> scap sync-world

Reason:
Done in 1279eb1898b926f75350cc07fbcb32530cace6ac by Lars.

https://gerrit.wikimedia.org/r/597832