Document usrc.py

Description

usrc.py is a local tool for using git repositories with upstream sources that are defined in 'automation/upstream-sources.yaml'.

We need some documentation about how to install and use this tool in our infra-docs.

Activity

Show:
Sahil Joseph
March 20, 2018, 7:41 AM

Hey I would like to write a full doc for this on infra docs . Can u please guide me barak ?

Barak Korren
March 20, 2018, 8:01 AM

sure that would be very useful! - you can start by cloning the 'jenkins' repo and running `scripts/usrc.py --help` from it

For some general idea about how we document the stand -alone CI tools, you can look at the mock_runner.sh documentation

As stated in the ticket description `usrc.py` is a tool for using source dependencies that are defined in `automation/upstream-sources.yaml`. More information about this kind of dependencies can be seen in the 'Defining extra source code dependencies' section here.

Once we have a doc about usrc.py, we can link to it from that section as well.

Assignee

Ehud Yonasi

Reporter

Barak Korren

Blocked By

None

Components

Priority

High
Configure