Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for conan cache backup-upload #3438

Merged
merged 2 commits into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions devops/backup_sources/sources_backup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ and future source downloads of this recipe will use the newly updated contents w
See :ref:`the packages list feature<examples_commands_pkglists>` for a way to only upload the packages that have been built


In case there's a need to upload backups for sources not linked to any package, or for packages that are already on the remote and would therefore be skipped during upload, the :command:`conan cache backup-upload` command can be used to address this scenario.

.. _backup_sources_setup_remote:

Creating the backup repository
Expand Down
21 changes: 21 additions & 0 deletions reference/commands/cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,3 +254,24 @@ For example, to verify the integrity of the whole Conan local cache, do:
mypkg/1.0:454923cd42d0da27b9b1294ebc3e4ecc84020747: Integrity checked: ok
zlib/1.2.11: Integrity checked: ok
zlib/1.2.11:6fe7fa69f760aee504e0be85c12b2327c716f9e7: Integrity checked: ok


conan cache backup-upload
-------------------------

.. code-block:: text

$ conan cache backup-upload -h
usage: conan cache backup-upload [-h] [-v [V]]

Upload all the source backups present in the cache

options:
-h, --help show this help message and exit
-v [V] Level of detail of the output. Valid options from less verbose
to more verbose: -vquiet, -verror, -vwarning, -vnotice,
-vstatus, -v or -vverbose, -vv or -vdebug, -vvv or -vtrace

The ``conan cache backup-upload`` will upload all source backups present in the local cache to the backup server,
(excluding those which have been fetched from the excluded urls listed in the ``core.sources:exclude_urls`` conf),
regardless of which package they belong to, if any.