[doc] Cleanup, update, elaborate #234

130s · 2017-11-17T10:03:40Z

See message and diff in each commit.

Elaborate custom Docker image (ref. make sudo optional #236 (comment))
Add share .docker with container #240 (review)

mathias-luedtke · 2017-11-17T10:43:00Z

👍 I will review it later!
Regarding the variables reference I proposed,#228, what do you think?

130s · 2017-12-10T09:45:35Z

Updated (a lot). @ipa-mdl please review.

130s · 2017-12-10T09:47:26Z

doc/index.rst

-Note-1. This disables the handling of `ROS_REPOSITORY_PATH` and `ROS_DISTRO` as ROS needs already to be installed in the image.
+Some more notes:
+- Specifying Docker image disables the handling of `ROS_REPO` (and non-recommended `ROS_REPOSITORY_PATH`), and `ROS_DISTRO` as ROS needs to be installed in the image.
+- For some images, `ROS_DISTRO` variable still needs to be set. This holds for `ROS official Docker images <https://hub.docker.com/_/ros/>`_ as of Sept. 2017.


I'm not sure if these 2 lines hold true.

This is a little bit tricky:

Specifying DOCKER_IMAGE disables the set-up of ROS based on ROS_REPO (or non-recommended ROS_REPOSITORY_PATH), and ROS_DISTRO, but ROS_DISTRO still needs to be set.

Regarding the the section above this note:

You can pull any Docker image by specifying in DOCKER_IMAGE variable, as long as the following requirement is met:

sources.list set up (example <http://wiki.ros.org/kinetic/Installation/Ubuntu#Installation.2BAC8-Ubuntu.2BAC8-> Sources.Setup_your_sources.list>_).

python-catkin-tools, python-pip, python-rosdep, python-wstool, ros-$ROS_DISTRO_catkin
If the image does not contain these packages, they can get installed by including them in ADDITIONAL_DEBS, too.

mathias-luedtke

Overall 👍, except for the ci_main.sh issue, this script should never get called directly.

mathias-luedtke · 2017-12-15T15:51:50Z

doc/index.rst


 ::

  before_config:
    - git clone https://github.com/ros-industrial/industrial_ci.git .ci_config
  script:
-    - .ci_config/travis.sh
+    - .ci_config/ci_main.sh  (Travis CI with GitHub)


Still .ci_config/travis.sh

There is even the generic .ci_config/ci.sh script that can be used with other CI systems or custom solutions like Jenkins.

mathias-luedtke · 2017-12-15T15:57:37Z

doc/index.rst

@@ -11,7 +11,7 @@ Introduction

 This repository contains `CI (Continuous Integration) <https://en.wikipedia.org/wiki/Continuous_integration>`_ configuration that can be commonly used by the repositories in `ros-industrial <https://github.com/ros-industrial>`_ organization. Non ros-industrial repositories in other organizations can utilize the CI config here too, as long as they are ROS-powered.

-As of December 2015, this repo provides configuration for `Travis CI`. The CI config in this repository is intended to be obtained by `git clone` feature. In client repos you can define custom, repository-specific checks, in addition to the generic configs stored in this repo.
+As of Novemeber 2017, this repo provides configuration for `Travis CI` and `Gitlab CI`. The CI configs in this repository are intended to be obtained by `git clone` feature. In client repos you can define custom, repository-specific checks, in addition to the generic configs stored in this repo.


"Novemeber"

130s · 2017-12-30T10:00:47Z

All feedback addressed. @ipa-mdl please review again.

I've squashed as much as I think reasonable but there are still a dozen. Personally I'd keep these as they are but do not mind squashing.

miguelprada · 2018-01-04T09:30:35Z

doc/index.rst

+(Gitlab CI) Access to private repositories
+------------------------------------------
+
+Every one who opens PRs/MRs (merge requests, that's what Gitlab calls pull requests) to repositories where CI jobs access private Gitlab repos are now required to add ssh private keys on their repos, including the forks (the following steps are cumbersome workaround, hopefully only temporary).


Instructions should be addressed to any repo where CI jobs need to access private upstream packages. What about:

Repositories where CI jobs access private Gitlab repos are required to add ssh private keys on their CI settings. Matching public keys must be set as deploy keys on the private repos that need to be accessed.

Furthermore, the specific setup for a fork of some other repo should either use the same private key or be able to add the new public key to the upstream repos, shouldn't it? Not sure how/where to add this, maybe some note for setting up CI for forks at the end of the section?

Furthermore, the specific setup for a fork of some other repo should either use the same private key or be able to add the new public key to the upstream repos, shouldn't it? Not sure how/where to add this, maybe some note for setting up CI for forks at the end of the section?

That sounds even more advanced. Not sure if we need information for that in industrial_ci's doc. In this PR, I've already gone far to walk through steps of how to add private and pub keys, which is not this package-specific and may be too much. You think that should be included here?

Not really. I just mention it because you were mentioning PRs/MRs and forks in the original paragraph.

miguelprada · 2018-01-04T09:31:09Z

doc/index.rst

+#. Open your fork with your account filled in in the repo's URLs below (the rest of the steps need to be done for these URLs). `%YOUR_GITLAB_DOMAIN%` can be `gitlab.com` if you're using the hosted version of Gitlab.
+
+   #. https://%YOUR_GITLAB_DOMAIN%/%YOUR_ACCOUNT%/%REPO_YOUR_BRANCH_RESIDES%/settings/ci_cd
+   #. https://%YOUR_GITLAB_DOMAIN%/%YOUR_ACCOUNT%/%REPO_YOUR_BRANCH_RESIDES%_test/settings/ci_cd


Why the _test repo?

miguelprada · 2018-01-04T09:50:10Z

doc/index.rst

+      # gitlab.com:22 SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2
+      gitlab.com ecdsa-sha2-nistp256 RandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequence
+      # gitlab.com:22 SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2
+


Missing instructions on setting up the public key as deploy key.

Maybe also add here something about forks?

Missing instructions on setting up the public key as deploy key.

Addressed in this line.

mathias-luedtke · 2018-01-04T12:07:24Z

doc/index.rst


+2. In `CI config <#terminology>`_ file in your client repo, add in `before_config` section a sentence `git clone https://github.com/ros-industrial/industrial_ci.git .ci_config`, like below:


Actually, there is no before_config section

mathias-luedtke · 2018-01-04T12:11:19Z

doc/index.rst

 ::

  before_config:
    - git clone https://github.com/ros-industrial/industrial_ci.git .ci_config
  script:
-    - .ci_config/travis.sh


This is confusing. Don't mix non-travis scripts with travis(-like) config.

I would suggest to don't touch this section for now and to improve it in another PR.
I guess we should have an extended quickstart for all supported CI systems.

mathias-luedtke · 2018-01-04T12:16:44Z

doc/index.rst

+On CI platform usually some variables are available for the convenience. Since all checks using `industrial_ci` are NOT running directly on the operating system running on CI, but instead running on `Docker` where those variables are not defined, dozens of them are already passed for you (you can see `the list of those variables <https://github.com/ros-industrial/industrial_ci/blob/master/industrial_ci/src/docker.env>`_).
+
+Still, you may want to pass some other vars. `DOCKER_RUN_OPTS='-e MY_VARIABLE_VALUE'` should do the trick.
+You can even set it to a specific value: `DOCKER_RUN_OPTS='-e MY_VARIABLE_VALUE=42'` (format varies per CI platform. These are Gitlab CI example).


This is the Travis format.
The Gitlab format (proper YAML!) would be: DOCKER_RUN_OPTS: '-e MY_VARIABLE_VALUE'.

In 38db36e I added a disclaimer in the new supported CI system section that the format in this doc is by default for Travis CI.

mathias-luedtke · 2018-01-04T12:19:14Z

doc/index.rst

+------------------------------------------
+
+Every one who opens PRs/MRs (merge requests, that's what Gitlab calls pull requests) to repositories where CI jobs access private Gitlab repos are now required to add ssh private keys on their repos, including the forks (the following steps are cumbersome workaround, hopefully only temporary).
+


This is no (temporary) workaround, but the officially documented way.

mathias-luedtke · 2018-01-04T12:23:12Z

doc/index.rst

@@ -257,7 +309,7 @@ The jobs that run Prerelease Test may usually take longer than the tests defined
      - ROS_DISTRO=indigo PRERELEASE=true
  :

-Then open a pull request using this branch against the branch that the change is subject to be merged. You do not want to actually merge this branch no matter what the Travis result is. This branch is solely for Prerelease Test purpose.
+Then open a pull request using this branch against the branch that the change is subject to be merged. You do not want to actually merge this branch no matter what the CI  result is. This branch is solely for Prerelease Test purpose.


double whitespace

mathias-luedtke · 2018-01-04T12:26:08Z

doc/index.rst

-    - .ci_config/travis.sh
+    - .ci_config/ci.sh
+
+Multiple commands can be passed, as in a general `bash` manner. Using semi-colon as a delimitter,::


I would not recommend semi-colons, these are error-prone in this context.

What's better if you want to pass multiple commands? && and/or ||?

Ok I got it https://github.com/ros-industrial/industrial_ci/pull/234/files#r159641174

For the limited scope of BEFORE_SCRIPT using && should be enough.
More complicated things should go into a script file.

mathias-luedtke · 2018-01-04T12:26:53Z

doc/index.rst

+
+For more complicated cases the commands should go into a dedicated script::
+
+    - BEFORE_SCRIPT='./my_before_script.sh'


This should be the recommendation for multiple commands.

130s · 2018-01-08T09:57:44Z

Thanks @ipa-mdl @miguelprada. Could you have a look again? Commits are separated for the sake of easier review.

miguelprada

I still find the instructions on setting up Gitlab CI for accessing private repos a bit confusing/misleading.

Find some suggestions in 85f6cec

miguelprada · 2018-01-08T13:44:08Z

doc/index.rst


-If your Docker image is missing any of the above libraries, then you can still pass their name by `ADDITIONAL_DEBS` (see `variables section <./index.rst#optional-environment-variables>`_).
+To open PRs/MRs (merge requests, that's what Gitlab calls pull requests) that access private Gitlab repos, additional setting is needed both on:


Instructions should not be limited to opening PRs/MRs. Any repo using GitLab CI where industrial_ci needs to access private repositories (anywhere), needs to setup authentication to do so.

miguelprada · 2018-01-08T13:45:53Z

doc/index.rst

+      gitlab.com ecdsa-sha2-nistp256 RandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequenceRandomKeySequence
+      # gitlab.com:22 SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2
+
+#. (Optional) If you're an admin of the private repos, add a public key (`refrence <https://docs.gitlab.com/ce/ssh/README.html#deploy-keys>`_).


This is not optional. If the private repositories your CI jobs need to access don't have the matching public key as deploy key (or somehow grant access to the private key you set up in your repo), all of the above won't work.

mathias-luedtke

My previous comments have been addressed 👍 , but I took another look ;)

As a general remark: If "Travis config" refers to a specific Travis example (or feature), we should not change it to "CI config"

mathias-luedtke · 2018-01-10T12:37:42Z

doc/index.rst

@@ -11,14 +11,17 @@ Introduction

 This repository contains `CI (Continuous Integration) <https://en.wikipedia.org/wiki/Continuous_integration>`_ configuration that can be commonly used by the repositories in `ros-industrial <https://github.com/ros-industrial>`_ organization. Non ros-industrial repositories in other organizations can utilize the CI config here too, as long as they are ROS-powered.

-As of December 2015, this repo provides configuration for `Travis CI`. The CI config in this repository is intended to be obtained by `git clone` feature. In client repos you can define custom, repository-specific checks, in addition to the generic configs stored in this repo.
+As of November 2017, this repo provides configuration for `Travis CI` and `Gitlab CI`. The CI configs in this repository are intended to be obtained by `git clone` feature. In client repos you can define custom, repository-specific checks, in addition to the generic configs stored in this repo.


I would subsitute "CI configs" with "CI scripts", the use here does not match the definition in the glossary.

mathias-luedtke · 2018-01-10T12:43:27Z

doc/index.rst

@@ -91,7 +108,7 @@ Prerequisite
 In order for your repository to get checked with configurations in `industrial_ci`, it needs:

 * To be a `Catkin package <http://wiki.ros.org/ROS/Tutorials/catkin/CreatingPackage>`_ (uses CMake for build configuration), since many checks are triggered by the `Catkin`-based commands.
-* Build-able on Linux (as of Dec 2015, Ubuntu 14.04/Trusty is used). Although your repository is not necessarilly intended for Linux, checks are run on Linux.
+* Docker image for the targeted operating system is available on a Docker registry (e.g. http://hub.docker.com, Gitlab registry) either publicly or privately.


Actually, this might confuse users if they are not used to Docker.
It is a requirement, but there is no special action to take for the ROS-supported linux systems.

mathias-luedtke · 2018-01-10T12:44:08Z

doc/index.rst

@@ -101,18 +118,19 @@ Here are some operations in your client repositories.
 To start using CI config stored in this repo
 --------------------------------------------------

-With the following few short steps, you can start in your client repository using CI confiurations stored in here (`industrial_ci` repository).
+With the following few short steps, you can start in your client repository using CI configurations stored in here (`industrial_ci` repository).


again, we don't use the configurations, but the scripts.

mathias-luedtke · 2018-01-10T12:46:15Z

doc/index.rst

 ::

-  before_config:
+  install:
    - git clone https://github.com/ros-industrial/industrial_ci.git .ci_config


Note: We should change this to .industrial_ci in the future. (new template in #105)

Note: We should change this to .industrial_ci in the future. (new template in #105)

Why is that?

Because it's no configuration at all ;)

mathias-luedtke · 2018-01-10T12:46:35Z

doc/index.rst

    - git clone https://github.com/ros-industrial/industrial_ci.git .ci_config
  script:
-    - .ci_config/travis.sh
+    - .ci_config/travis.sh    


130s · 2018-02-05T09:39:00Z

@miguelprada

I still find the instructions on setting up Gitlab CI for accessing private repos a bit confusing/misleading.

Find some suggestions in 85f6cec

I couldn't find your suggested change in that commit. If you could open a PR to my fork I'm happy to review that.

miguelprada · 2018-02-06T15:25:13Z

It seems you changed some stuff and force pushed to your branch since I did that commit, so it no longer applies cleanly. I tried to replicate what I was suggesting in 130s#17.

The main points of confusion for me are summarized in the PR comments. In any case, it's just my opinion, so feel free to ignore my suggestions altogether 😄

…ent)).

…(feedback ros-industrial#234 (comment)).

- Passing multiple {script/command}(s) are missing. - Link to detail missing. [doc] More sample for BEFORE/AFTER_SCRIPT. Not using double quote. [doc] Clarify the timing BEFORE_SCRIPT gets called.

…#236 (comment) [doc] More elaboration about specific Docker image passing.

https://github.com/ros-industrial/industrial_ci/pull/234/files#r157238057

…but undocumented)

Addresses https://github.com/ros-industrial/industrial_ci/pull/234/files#r159639506

[doc] Add a template for Travis CI 9to address ros-industrial#105)

… CI.

[doc] Accordance with glossary https://github.com/ros-industrial/industrial_ci/pull/234/files#r160664100

…ent)).

…(feedback ros-industrial#234 (comment)).

130s · 2018-04-23T08:15:14Z

@ipa-mdl @miguelprada All of your feedback should be addressed. Please review.

This PR has sit here for half an year (my bad). I'd like to rather go ahead merge and tag a new ticket for additions if any.

miguelprada

Other than the few comments below, looks good to me.

miguelprada · 2018-04-23T12:01:33Z

doc/index.rst


-* Note that `.ci_config` is the required name of the cloned folder; it is hardcoded so you need to use this name.
+* Note that `.industrial_ci` is the required name of the cloned folder; it is hardcoded so you need to use this name.


README.rst claims the opposite. Whichever is wrong should be corrected.

miguelprada · 2018-04-23T12:05:55Z

doc/index.rst

+* **CATKIN_PARALLEL_JOBS** (default: -p4): Maximum number of packages to be built in parallel that is passed to underlining build tool. As of Jan 2016, this is only enabled with `catkin_tools`. See for more detail about `number of build jobs <http://catkin-tools.readthedocs.org/en/latest/verbs/catkin_build.html#controlling-the-number-of-build-jobs>`_ and `documentation of catkin_tools <https://catkin-tools.readthedocs.org/en/latest/verbs/catkin_build.html#full-command-line-interface>`_ that this env variable is passed to internally in `catkin-tools`.
+* **CATKIN_PARALLEL_TEST_JOBS** (default: -p4): Maximum number of packages which could be examined in parallel during the test run. If not set it's filled by `ROS_PARALLEL_JOBS`.
+* **CCACHE_DIR** (default: not set): If set, `ccache <https://en.wikipedia.org/wiki/Ccache>`_ gets enabled for your build to speed up the subsequent builds in the same job if anything. See `detail. <https://github.com/ros-industrial/industrial_ci/blob/master/doc/index.rst#cache-build-artifacts-to-speed-up-the-subsequent-builds-if-any>`_
+* **CI_PARENT_DIR** (default: .industrial_ci): (NOT recommended to specify) This is the folder name that is used in downstream repositories in order to point to this repo.


Seems like this is no longer used. Shouldn't it be removed from the list?

miguelprada · 2018-04-23T12:08:47Z

doc/index.rst

+- https://docs.gitlab.com/ce/ssh/README.html
+- https://docs.gitlab.com/ee/ci/ssh_keys/README.html
+
+Pass custom variables to Docker


Duplicated above (Gitlab CI) Access to private repositories section.

miguelprada · 2018-04-23T12:12:02Z

doc/index.rst


-NOTE: If you specify scripts in `script` section without using aforementioned variables, those will be run directly on CI, not on the `Docker` where `.ci_config/travis.sh` runs on.::
+NOTE: In general the scripts are run as root in a Docker container. If you configures a different (base) Docker image, the user could be changed to non-root. But since we need to install packages the (base) image should set-up `sudo` for this user.


Typo: ... If you configure a different (base)...

…(feedback ros-industrial#234 (comment)). [doc] Fix contradicting folder name practice (addressing ros-industrial#234 (comment))).

130s · 2018-04-30T09:10:20Z

@miguelprada Thanks, could you give a (hopefully one last) look?

miguelprada

Sorry for not having caught this one before. The "Quick Start" instructions for Gitlab CI need a bit of tweaking. I suggested some rewording below.

miguelprada · 2018-05-02T12:39:34Z

README.rst


- `industrial_core/.travis.yml <https://github.com/ros-industrial/industrial_core/blob/eeb6a470e05233d0efaaf8c32a9e4133cdcbb80b/.travis.yml>`_: Indigo and Jade compatible.
- `leap_motion/.travis.yml <https://github.com/ros-drivers/leap_motion/blob/954924befd2a6755f9d310f4a8b57aa526056a80/.travis.yml>`_: Indigo, Jade, Kinetic compatible. Also runs `ROS Prerelease Test <http://wiki.ros.org/bloom/Tutorials/PrereleaseTest>`_.
+1. In `.gitlab-ci.yml` file in your client repo, add in "`install`" section a sentence `git clone https://github.com/ros-industrial/industrial_ci.git .industrial_ci`, like below:


You also need to enable CI for your repo by assigning a suitable runner to it, which can be done in Settings > CI/CD > Runners settings.

There is probably more than one way to set up the runner. The .gitlab-ci.yml in this repo is set up to use a runner configured with the Docker executor (i.e. implicit by its use of image and services keywords). I do, however, think that step-by-step instructions on how to set this up are probably beyond the scope of this README.

Also, .gitlab-ci.yml should use before_script instead of install for cloning industrial_ci, and the following line should be a minimal job configuration.

I would propose something like:

Enable a runner for your Gitlab project which uses the Docker executor. See instructions on how to install and register such a runner with your Gitlab instance if you haven't done so yet.

In .gitlab-ci.yml file in your client repo, add the following minimal configuration, replacing indigo for your chosen distro:

image: docker:git services: - docker:dind before_script: - apk add --update bash coreutils tar - git clone https://github.com/ros-industrial/industrial_ci .industrial_ci indigo: script: .industrial_ci/gitlab.sh ROS_DISTRO=indigo

Thanks. I agree to just briefly mention the need for setting up Pipeline and rely on the external source for the detail. I've basically applied your suggestion in the updated commit, with a minor change to give a hint about unclarity of gitlab.com version and your-own-server version that I find not clear for the most of the times in the docs on Gitlab.

miguelprada · 2018-05-02T12:40:27Z

README.rst

+   - `example 1 <https://github.com/ros-industrial/industrial_core/blob/eeb6a470e05233d0efaaf8c32a9e4133cdcbb80b/.travis.yml>`_ (Indigo and Jade compatible).
+   - `example 2 <https://github.com/ros-drivers/leap_motion/blob/954924befd2a6755f9d310f4a8b57aa526056a80/.travis.yml>`_ (Indigo, Jade, Kinetic compatible. Also runs `ROS Prerelease Test <http://wiki.ros.org/bloom/Tutorials/PrereleaseTest>`_).
+- For development branch intended for ROS Kinetic: `industrial_core <https://github.com/ros-industrial/industrial_core/blob/a07f9089b0f6c8a931bab80b7fca959dd6bba05b/.travis.yml>`_
+- For more complexed example: `.travis.yml <https://github.com/ros-industrial/industrial_ci/blob/d09b8dd40d7f1fa1ad5b62323a1d6b2ca836e558/.travis.yml>`_ from the same repo. You can see how options are used.


Link to .gitlab-ci.yml in industrial_ci as well?

…34 (review)).

miguelprada · 2018-05-08T08:11:51Z

Great. Looks good to me now 👍

130s · 2018-05-08T16:20:03Z

Thanks @miguelprada

I'll dismiss "requested changes" and merge, as this sits unmerged for while as I said #234 (comment). For any new concern please feel free to open new tickets.

It's stale, and see #234 (comment)

130s requested a review from mathias-luedtke November 17, 2017 10:03

130s mentioned this pull request Nov 17, 2017

Passing custom environment variable to Docker images #233

Closed

130s changed the title ~~[doc] Cleanup, update, elaborate~~ WIP: [doc] Cleanup, update, elaborate Dec 2, 2017

130s mentioned this pull request Dec 2, 2017

make sudo optional #236

Merged

130s force-pushed the doc/docker_opts branch from 105ef1b to b8ad0e8 Compare December 10, 2017 07:18

130s mentioned this pull request Dec 10, 2017

[doc] More elaboration BEFORE/AFTER_SCRIPT variables. #225

Closed

130s changed the title ~~WIP: [doc] Cleanup, update, elaborate~~ [doc] Cleanup, update, elaborate Dec 10, 2017

130s commented Dec 10, 2017

View reviewed changes

mathias-luedtke requested changes Dec 15, 2017

View reviewed changes

130s force-pushed the doc/docker_opts branch from 12a7bb0 to b316cd0 Compare December 30, 2017 09:58

130s force-pushed the doc/docker_opts branch 3 times, most recently from f0dc22e to 7c8dd44 Compare December 31, 2017 03:25

130s mentioned this pull request Jan 3, 2018

setup ssh key forwarding in gitlab #243

Merged

miguelprada requested changes Jan 4, 2018

View reviewed changes

mathias-luedtke requested changes Jan 4, 2018

View reviewed changes

miguelprada reviewed Jan 8, 2018

View reviewed changes

mathias-luedtke previously requested changes Jan 10, 2018

View reviewed changes

130s force-pushed the doc/docker_opts branch from de8d47e to 3bc4485 Compare February 5, 2018 09:33

130s mentioned this pull request Feb 5, 2018

Improve user instruction #105

Open

6 tasks

miguelprada mentioned this pull request Feb 6, 2018

Slight reword of the section on private repo access from Gitlab CI 130s/industrial_ci#17

Merged

130s added a commit to 130s/industrial_ci that referenced this pull request Apr 23, 2018

[doc] Update pre-requiste (based on feedback ros-industrial#234 (comm…

69d297e

…ent)).

130s added a commit to 130s/industrial_ci that referenced this pull request Apr 23, 2018

[doc] Update default cloned folder from .ci_config to .industrial_ci …

425cbfb

…(feedback ros-industrial#234 (comment)).

[doc] Typo.

6429564

130s and others added 14 commits April 23, 2018 00:42

[doc] Elaborate non-Docker before/after script.

378941a

[doc] More elaboration BEFORE/AFTER_SCRIPT variables.

2e13b2b

- Passing multiple {script/command}(s) are missing. - Link to detail missing. [doc] More sample for BEFORE/AFTER_SCRIPT. Not using double quote. [doc] Clarify the timing BEFORE_SCRIPT gets called.

[doc] Elaborate about the necessity for sudo in Docker ros-industrial…

fd2eb54

…#236 (comment) [doc] More elaboration about specific Docker image passing.

[doc] Minor .rst formatting

76487a2

[doc] Address review feedback about Docker image usage.

fb475db

https://github.com/ros-industrial/industrial_ci/pull/234/files#r157238057

[doc] Add gitlab private repo access (discussed in ros-industrial#243 …

96b6774

…but undocumented)

[doc] Update based on the feedback about gitlab private repo access.

e085992

[doc] Add supported CI system.

8e7bbf4

Addresses https://github.com/ros-industrial/industrial_ci/pull/234/files#r159639506

[doc] More feedback (correction of and better commands).

3c7ddd9

[readme] Better format.

b2d2838

[doc] Split Travis and Gitlab in the quick start section.

985ee87

[doc] Add a template for Travis CI 9to address ros-industrial#105)

[doc] Slight reword of the section on private repo access from Gitlab…

fc44bdc

… CI.

[doc] Elaborate variables on Docker.

0d0f536

[doc] Accordance with glossary https://github.com/ros-industrial/industrial_ci/pull/234/files#r160664100

[doc] Update pre-requiste (based on feedback ros-industrial#234 (comm…

db62ada

…ent)).

130s force-pushed the doc/docker_opts branch from 425cbfb to 0c6d28d Compare April 23, 2018 07:42

130s added a commit to 130s/industrial_ci that referenced this pull request Apr 23, 2018

[doc] Update default cloned folder from .ci_config to .industrial_ci …

0c6d28d

…(feedback ros-industrial#234 (comment)).

miguelprada requested changes Apr 23, 2018

View reviewed changes

130s added 2 commits April 30, 2018 02:05

[doc] Update default cloned folder from .ci_config to .industrial_ci …

fc6928a

…(feedback ros-industrial#234 (comment)). [doc] Fix contradicting folder name practice (addressing ros-industrial#234 (comment))).

[doc] Minor fix (addressing ros-industrial#234 (review)).

53a1a5f

130s force-pushed the doc/docker_opts branch from 0c6d28d to 53a1a5f Compare April 30, 2018 09:08

miguelprada previously requested changes May 2, 2018

View reviewed changes

[doc] Improvement for Gitlab CI (addressing feedback ros-industrial#2…

d6d5cbd

…34 (review)).

130s merged commit 0333531 into ros-industrial:master May 8, 2018

130s deleted the doc/docker_opts branch May 8, 2018 16:21


		2. In `CI config <#terminology>`_ file in your client repo, add in `before_config` section a sentence `git clone https://github.com/ros-industrial/industrial_ci.git .ci_config`, like below:

		------------------------------------------

		Every one who opens PRs/MRs (merge requests, that's what Gitlab calls pull requests) to repositories where CI jobs access private Gitlab repos are now required to add ssh private keys on their repos, including the forks (the following steps are cumbersome workaround, hopefully only temporary).


		For more complicated cases the commands should go into a dedicated script::

		- BEFORE_SCRIPT='./my_before_script.sh'


		If your Docker image is missing any of the above libraries, then you can still pass their name by `ADDITIONAL_DEBS` (see `variables section <./index.rst#optional-environment-variables>`_).
		To open PRs/MRs (merge requests, that's what Gitlab calls pull requests) that access private Gitlab repos, additional setting is needed both on:


		* Note that `.ci_config` is the required name of the cloned folder; it is hardcoded so you need to use this name.
		* Note that `.industrial_ci` is the required name of the cloned folder; it is hardcoded so you need to use this name.


		NOTE: If you specify scripts in `script` section without using aforementioned variables, those will be run directly on CI, not on the `Docker` where `.ci_config/travis.sh` runs on.::
		NOTE: In general the scripts are run as root in a Docker container. If you configures a different (base) Docker image, the user could be changed to non-root. But since we need to install packages the (base) image should set-up `sudo` for this user.

[doc] Cleanup, update, elaborate #234

[doc] Cleanup, update, elaborate #234

Conversation

130s commented Nov 17, 2017 • edited Loading

mathias-luedtke commented Nov 17, 2017

130s commented Dec 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mathias-luedtke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

130s commented Dec 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mathias-luedtke Jan 4, 2018 • edited Loading

Choose a reason for hiding this comment

130s commented Jan 8, 2018

miguelprada left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mathias-luedtke left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

130s commented Feb 5, 2018

miguelprada commented Feb 6, 2018

130s commented Apr 23, 2018

miguelprada left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

130s commented Apr 30, 2018

miguelprada left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelprada commented May 8, 2018

130s commented May 8, 2018

130s commented Nov 17, 2017 •

edited

Loading

mathias-luedtke Jan 4, 2018 •

edited

Loading

mathias-luedtke left a comment •

edited

Loading

miguelprada left a comment •

edited

Loading