.. ##
.. ## Copyright (c) 2022, Lawrence Livermore National Security, LLC and
.. ## other RADIUSS Project Developers. See the top-level COPYRIGHT file for details.
.. ##
.. ## SPDX-License-Identifier: (MIT)
.. ##

.. _dev_common_issues-label:

*************
Common Issues
*************

=====================================================================
Project ``radiuss/radiuss-shared-ci`` reference [...] does not exist!
=====================================================================

.. image:: images/error-mirrored-reference.png
   :scale: 45 %
   :alt: Check that the reference is mirrored on LC GitLab.
   :align: center


If you are attempting to use a specific reference in ``radiuss-shared-ci``, make
sure this reference has been mirrored on LC GitLab: be sure to create a PR on
GitHub so that the mirroring happens.

This error may arise when developing on a new branch in ``radiuss-shared-ci``,
The development repository is on GitHub.com but in the CI configuration we
recommend that projects point to the LC GitLab clone.

=========================================================
Invalid character ``\x1b`` looking for beginning of value
=========================================================

.. image:: images/error-empty-custom-dir.png
   :scale: 30 %
   :alt: Check that the reference is mirrored on LC GitLab.
   :align: center

This error appears if you leave ``CUSTOM_CI_BUILDS_DIR: ""`` uncommented in
``.gitlab/custom-jobs-and-variables.yml`` (as suggested in earlier versions of
the documentation), usually when no service account is in use.

Simply comment that line. Setting the variable to an empty value generates
a failure in the runner initialization script.