Skip to content
Snippets Groups Projects
Commit 620f56e0 authored by Iñigo Moreno i Caireta's avatar Iñigo Moreno i Caireta
Browse files

Update documentation

parent 641149b1
No related branches found
No related tags found
1 merge request!70Resolve "Update deprecated deploy job"
Pipeline #59231 passed
...@@ -9,11 +9,3 @@ include::ci-templates/README.adoc[leveloffset=+1] ...@@ -9,11 +9,3 @@ include::ci-templates/README.adoc[leveloffset=+1]
== Custom `rosdep` definitions == Custom `rosdep` definitions
Custom `rosdep` definitions for the packages hosted in our internal debian repository are declared in link:rosdistro/rosdep_tecnalia.yaml[]. Custom `rosdep` definitions for the packages hosted in our internal debian repository are declared in link:rosdistro/rosdep_tecnalia.yaml[].
== Deployment image build resources
Resources required for building the deployment docker images are also hosted in this repository.
This basically boils down to:
- link:scripts/pre-deploy-cleanup.bash[] is run in the `.industrial_ci_deploy` template before commiting to an image
- link:deploy/Dockerfile[] is used to perform some additional cleanup and install link:deploy/ros_entrypoint.bash[] as entrypoint script on top of the `industrial_ci` image
...@@ -17,11 +17,14 @@ The Core pipeline, defined in link:ci-templates/core.yml[], has the following st ...@@ -17,11 +17,14 @@ The Core pipeline, defined in link:ci-templates/core.yml[], has the following st
** If the package has `.rosinstall` dependencies, they can be installed using the variable `UPSTREAM_WORKSPACE` ** If the package has `.rosinstall` dependencies, they can be installed using the variable `UPSTREAM_WORKSPACE`
** Uses `flexbotics-base-devel:${ROS_DISTRO}` as a starting image ** Uses `flexbotics-base-devel:${ROS_DISTRO}` as a starting image
** Runs link:scripts/ci_run_entry_points.sh[] in the `AFTER_SETUP_TARGET_WORKSPACE` stage, which in turn finds and runs every `ci_entry_script.bash` script found in the target repo. ** Runs link:scripts/ci_run_entry_points.sh[] in the `AFTER_SETUP_TARGET_WORKSPACE` stage, which in turn finds and runs every `ci_entry_script.bash` script found in the target repo.
* `.industrial_ci_deploy` template, which: - Stage: `deploy`
** Runs `industrial_ci` by extending `.industrial_ci` * `.ddeploy` template (see https://git.code.tecnalia.com/tecnalia_robotics/flexbotics/flexbotics_utils/ddeploy[the ddeploy repo]), which:
** Runs some cleanup in the `industrial_ci` context (e.g. delete sources) ** Is run automatically for tags, but can also be run manually on normal commits
** Commits image used by `industrial_ci` ** Calls `ddeploy` to generate the docker image
** Builds deployment image on top of it and push it to our registry ** Renames the image created by ddeploy with different tags and pushes them to the registry.
*** Tag `${COMMIT_SHA}` (hash of commit)
*** Tag `${CI_COMMIT_REF_SLUG}` (branch or tag name)
*** Tag `latest` only on the default branch
- Stage: `.post` - Stage: `.post`
* Check `bash`/`sh` script syntax * Check `bash`/`sh` script syntax
* Check Markdown and AsciiDoc syntax * Check Markdown and AsciiDoc syntax
...@@ -52,6 +55,8 @@ The auto rules also allow for using variables to explicitely activate each job: ...@@ -52,6 +55,8 @@ The auto rules also allow for using variables to explicitely activate each job:
include::examples/build_vars.yml[] include::examples/build_vars.yml[]
``` ```
If a `ddeploy.yaml` file exists, the auto-rules will add a job extending the `.ddeploy` template defined
== LFS == LFS
By default, lfs files are not downloaded. If you need to add LFS, include the link:ci-templates/lfs-pull.yml[] along with anything else: By default, lfs files are not downloaded. If you need to add LFS, include the link:ci-templates/lfs-pull.yml[] along with anything else:
```yml ```yml
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment