Make the synchro script more robust

XMLWordPrintableJSON

    • None
    • Python Drivers
    • Not Needed
    • None
    • None
    • None
    • None
    • None
    • None

      Context

      The synchro script can be made more robust to failure, and give better error messages when things go wrong.

      • We should use information from git to detect changes to synchro files, and bail early.
      • We should use git state to determine which files to synchronize by default.
      • If synchro fails, we should give better error messages and return the repo to the state it was in before running synchro.
      • We should be verbose in the static GitHub job so we can see the failures.
      • We should add unit tests to verify synchro behavior and prevent regressions.
      • When using run-tests, run synchro without ruff format to ensure the synch files are up to date.
      • When committing, run ruff format on changed files then synchro with ruff-format, and then re-add the files to prevent the common pattern of needing to re-commit.
      • In CI, error out if running ruff-format changes the files.

      Definition of done

      Synchro behavior is updated and tested locally for robustness, and unit tests pass.

      Pitfalls

      We need to make sure there are no usability regressions.

            Assignee:
            Steve Silvester
            Reporter:
            Steve Silvester
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: