From 3d088b2fb4d576d1576cb196d604b31470b01e97 Mon Sep 17 00:00:00 2001 From: "Marco A. Gutierrez" Date: Mon, 22 Jan 2024 07:09:07 +0000 Subject: [PATCH] Updaing environment ros_buildfarm instructions. Signed-off-by: Marco A. Gutierrez --- doc/environment.rst | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/doc/environment.rst b/doc/environment.rst index abac615ac..c0da4f785 100644 --- a/doc/environment.rst +++ b/doc/environment.rst @@ -35,24 +35,36 @@ The following commands can be used on Ubuntu Xenial and newer:: pip3 install rosdistro pip3 install ros_buildfarm +**Note** that the PIP release of ``ros_buildfarm`` might be outdated and give you +issues. It is recommended to install a later version using the instructions +detailed in the `section here <#using-a-different-version-of-ros_buildfarm>`_. + Provide credentials for Jenkins master -------------------------------------- To allow ``ros_buildfarm`` to configure any jobs on the Jenkins master it -requires credentials. -Create the `.ini `_ file ``~/.buildfarm/jenkins.ini`` containing your credentials to log in to the Jenkins master, e.g.:: +requires credentials. Create the +`.ini `_ file +``~/.buildfarm/jenkins.ini`` containing your credentials to log in to the +Jenkins master, e.g.:: [http://jenkins-instance-url.example.com:8080] username=admin password=changeme -You can put multiple separate sections for different hosts into the configuration file as well as use a section ``[DEFAULT]`` which is being used if no host specific section is found. +You can put multiple separate sections for different hosts into the +configuration file as well as use a section ``[DEFAULT]`` which is +being used if no host specific section is found. -Instead of putting the plain password in this configuration you can use the *API token* of your Jenkins user. -To get the API token (or change it) go to the *configure* page of your Jenkins user (http://YOUR-JENKINS/me/configure). +Instead of putting the plain password in this configuration you can use the +*API token* of your Jenkins user. To get the API token (or change it) go to +the *configure* page of your Jenkins user (http://YOUR-JENKINS/me/configure). -If you are using your GitHub account to log in to Jenkins you can use a token instead of your plain text password (see the `GitHub help `_ on how to create a token). +If you are using your GitHub account to log in to Jenkins you can use a +token instead of your plain text password (see the +`GitHub help `_ +on how to create a token). Using a different version of ros_buildfarm ------------------------------------------ @@ -78,6 +90,11 @@ But be aware that some changes in ``ros_buildfarm`` require configured Jenkins jobs and the scripts in the ``ros_buildfarm`` repository to be in sync and therefore to redeploy the Jenkins jobs. +Alternatively, you can also use PIP to install a specific branch or tag from the +original repo through its +`VCS support `_:: + + pip install https://github.com/ros-infrastructure/ros_buildfarm.git@master Using forked version of ros_buildfarm ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^