Go to file
Mike Frysinger e5670c8812 launcher: add a requirements framework to declare version dependencies
Currently we don't have a way for the checked out repo version to
declare the version of tools it needs before we start running it.
For somethings, like git, it's not a big deal as it can handle all
the asserts itself.  But for things like Python, it's impossible
to reliably check before executing.

We're in this state now:
- we've been allowing Python 3.4, so the launcher accepts it
- the repo codebase starts using Python 3.6 features
- launcher tries to import us but hits syntax errors
- user is left confused and assuming new repo is broken because
  they're seeing syntax errors

This scenario is playing out with old launchers that still accept
Python 2, and will continue to play out as time goes on and we want
to require newer versions of Python 3.

Lets create a JSON file to declare all these system requirements.
That file format is extremely stable, so loading & parsing from
even ancient versions of Python shouldn't be a problem.  Then the
launcher can read these settings and check the system state before
attempting to execute any code.  If the tools are too old, it can
clearly diagnose & display information to the user as to the real
problem (and not emit tracebacks or syntax errors).

We have a couple of different tool version checks already (git,
python, ssh) and can harmonize them in a single place.

This also allows us to assert a reverse dependency if the need
ever comes up: force the user to upgrade their `repo` launcher
before we'll let them run us.  Even though the launcher warns
whenever a newer release is available, some users seem to ignore
that, or they don't use repo that often (on the scale of years),
and their upgrade jump is so dramatic that they fall back into
the syntax error pit.

Hopefully by the end of the year we can assume enough people
have upgraded their launcher such that we can delete all of the
duplicate version checks in the codebase.  But until then, we'll
keep them to maintain coverage.

Change-Id: I5c12bbffdfd0a8ce978f39aa7f4674026fe9f4f8
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/293003
Reviewed-by: Michael Mortensen <mmortensen@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
2021-01-19 16:48:21 +00:00
.github/workflows switch to "main" branch for development 2020-11-16 05:07:33 +00:00
docs manifest_xml: - Added doc and testing of unknown tags/elements. 2021-01-12 21:49:13 +00:00
hooks Revert "commit-msg: Insert Change-Id at start of trailers" 2020-04-15 07:17:16 +00:00
release release-process: document schedule (including freezes) publicly 2020-07-23 08:07:38 +00:00
subcmds version: add remote tracking information 2021-01-08 20:41:27 +00:00
tests launcher: add a requirements framework to declare version dependencies 2021-01-19 16:48:21 +00:00
.flake8 flake8: Suppress "E731 do not assign a lambda expression, use a def" 2020-02-15 03:41:17 +00:00
.gitattributes Adds additional crlf clobber avoidance. 2016-06-22 08:36:45 +00:00
.gitignore Add parallelism to 'branches' command 2020-12-14 23:35:12 +00:00
.mailmap Update .mailmap 2020-02-13 04:49:55 +00:00
.project Set correct name in PyDev and Eclipse project config 2013-04-19 09:35:43 +09:00
.pydevproject Leverage the next keyword from python 2.7 2018-12-19 11:06:35 -08:00
color.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
command.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
editor.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
error.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
event_log.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
git_command.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
git_config.py drop pyversion & is_python3 checking 2021-01-06 18:53:58 +00:00
git_refs.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
git_ssh add license header to a few more files 2019-06-13 13:23:19 -04:00
git_trace2_event_log.py Fix bug in git trace2 event Write() function when no config present. 2021-01-07 14:31:51 +00:00
gitc_utils.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
hooks.py drop pyversion & is_python3 checking 2021-01-06 18:53:58 +00:00
LICENSE setup.py: add basic packaging files 2019-12-02 04:23:31 +00:00
main.py drop pyversion & is_python3 checking 2021-01-06 18:53:58 +00:00
manifest_xml.py manifest_xml: initial support for <superproject> 2021-01-08 19:49:52 +00:00
MANIFEST.in setup.py: add basic packaging files 2019-12-02 04:23:31 +00:00
pager.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
platform_utils_win32.py drop pyversion & is_python3 checking 2021-01-06 18:53:58 +00:00
platform_utils.py drop pyversion & is_python3 checking 2021-01-06 18:53:58 +00:00
progress.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
project.py drop pyversion & is_python3 checking 2021-01-06 18:53:58 +00:00
README.md README: use new bug template 2020-02-26 23:20:43 +00:00
repo launcher: add a requirements framework to declare version dependencies 2021-01-19 16:48:21 +00:00
repo_trace.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
requirements.json launcher: add a requirements framework to declare version dependencies 2021-01-19 16:48:21 +00:00
run_tests strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
setup.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00
SUBMITTING_PATCHES.md switch to "main" branch for development 2020-11-16 05:07:33 +00:00
tox.ini stop testing Python 2.7 2020-09-06 17:53:47 +00:00
wrapper.py strip python2-only coding:utf-8 & print_function settings 2021-01-06 18:53:05 +00:00

repo

Repo is a tool built on top of Git. Repo helps manage many Git repositories, does the uploads to revision control systems, and automates parts of the development workflow. Repo is not meant to replace Git, only to make it easier to work with Git. The repo command is an executable Python script that you can put anywhere in your path.

Contact

Please use the repo-discuss mailing list or issue tracker for questions.

You can file a new bug report under the "repo" component.

Please do not e-mail individual developers for support. They do not have the bandwidth for it, and often times questions have already been asked on repo-discuss or bugs posted to the issue tracker. So please search those sites first.

Install

Many distros include repo, so you might be able to install from there.

# Debian/Ubuntu.
$ sudo apt-get install repo

# Gentoo.
$ sudo emerge dev-vcs/repo

You can install it manually as well as it's a single script.

$ mkdir -p ~/.bin
$ PATH="${HOME}/.bin:${PATH}"
$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
$ chmod a+rx ~/.bin/repo